docs: Mention $BUFFER

This commit is contained in:
Matthew Martin 2016-05-12 22:09:45 -05:00
parent 13018f3dd7
commit 19acd8e844

View File

@ -7,7 +7,8 @@ The tests harness expects the highlighter directory to contain a `test-data`
directory with test data files. directory with test data files.
See the [main highlighter](../highlighters/main/test-data) for examples. 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"`. The value of that parameter is a list of strings of the form `"$i $j $style"`.
or `"$i $j $style $todo"`. or `"$i $j $style $todo"`.
Each string specifies the highlighting that `$BUFFER[$i,$j]` should have; Each string specifies the highlighting that `$BUFFER[$i,$j]` should have;