From 13018f3dd735a1651fd10988981db65723560ef4 Mon Sep 17 00:00:00 2001 From: Matthew Martin Date: Thu, 5 May 2016 23:31:31 -0500 Subject: [PATCH] docs: Document use of NONE in expected_region_highlight --- tests/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/tests/README.md b/tests/README.md index 2674aa7..06307c2 100644 --- a/tests/README.md +++ b/tests/README.md @@ -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"`. 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. +`$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 point will not fail the test), and `$todo` is used as the explanation.