From 19acd8e844e6a8edd4f3dc49a4b71292d3a6c316 Mon Sep 17 00:00:00 2001 From: Matthew Martin Date: Thu, 12 May 2016 22:09:45 -0500 Subject: [PATCH] docs: Mention `$BUFFER` --- tests/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tests/README.md b/tests/README.md index 06307c2..6461708 100644 --- a/tests/README.md +++ b/tests/README.md @@ -7,7 +7,8 @@ The tests harness expects the highlighter directory to contain a `test-data` directory with test data files. See the [main highlighter](../highlighters/main/test-data) for examples. -Each test should define the array parameter `$expected_region_highlight`. +Each test should define the string `$BUFFER` that is to be highlighted and the +array parameter `$expected_region_highlight`. The value of that parameter is a list of strings of the form `"$i $j $style"`. or `"$i $j $style $todo"`. Each string specifies the highlighting that `$BUFFER[$i,$j]` should have;