docs: Document use of NONE in expected_region_highlight

This commit is contained in:
Matthew Martin 2016-05-05 23:31:31 -05:00
parent 0f43026bf0
commit 13018f3dd7

View File

@ -12,6 +12,8 @@ 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;
that is, `$i` and `$j` specify a range, 1-indexed, inclusive of both endpoints. that is, `$i` and `$j` specify a range, 1-indexed, inclusive of both endpoints.
`$style` is either a key of `$ZSH_HIGHLIGHT_STYLES` or `NONE` to specify no
highlighting should be observed.
If `$todo` exists, the test point is marked as TODO (the failure of that test If `$todo` exists, the test point is marked as TODO (the failure of that test
point will not fail the test), and `$todo` is used as the explanation. point will not fail the test), and `$todo` is used as the explanation.