Merge remote-tracking branch 'sidkshatriya/highlighter-doc-edits'

This commit is contained in:
Maxime Coste 2022-06-04 10:51:56 +10:00
commit dc1ee01c98

View File

@ -218,15 +218,15 @@ add-highlighter <path>/<name>/<region_name> region \
*recurse*:: *recurse*::
regex that defines the text that matches recursively an end token regex that defines the text that matches recursively an end token
into the region, every match of *recurse* will consume a following into the region, every match of *recurse* will consume a following
match of *end*, preventing it from closing the region. match of *closing* regex, preventing it from closing the region.
*type* and *params*:: *type* and *params*::
A highlighter type, and associated params, as they would be passed A highlighter type, and associated params, as they would be passed
to `add-highlighter` if they were not applied as a region. to `add-highlighter` if they were not applied as a region.
If the *-match-capture* switch is passed, then region closing and recurse If the *-match-capture* switch is passed, then region *closing* and *recurse*
matches are considered valid for a given region opening match only if they regex matches are considered valid for a given region opening match only if they
matched the same content for the capture 1. matched the same content for the capture 1 in the *opening* regex.
The *recurse* option is useful for regions that can be nested, for example The *recurse* option is useful for regions that can be nested, for example
the following construct: the following construct: