adam/vim
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

runtime(doc): Improve the doc for :syn-containedin

Browse Source 
closes: #18290

Co-authored-by: h_east <h.east.727@gmail.com>
Signed-off-by: Damien Lejay <damien@lejay.be>
Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
Damien Lejay
2025-09-15 18:05:18 +00:00
committed by Christian Brabandt
parent 958ae91f3a
commit 8e0d374e4d
1 changed files with 8 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
runtime/doc/syntax.txt
View File

@ -1,4 +1,4 @@
*syntax.txt* For Vim version 9.1. Last change: 2025 Sep 14 *syntax.txt* For Vim version 9.1. Last change: 2025 Sep 15
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -4866,6 +4866,12 @@ The "containedin" argument is followed by a list of syntax group names. The
item will be allowed to begin inside these groups. This works as if the item will be allowed to begin inside these groups. This works as if the
containing item has a "contains=" argument that includes this item. containing item has a "contains=" argument that includes this item.
Only the immediate containing item (the one at the top of the syntax stack) is
considered. Vim does not search other ancestors. If the immediate container
neither contains this item via |:syn-contains| nor is named in this item's
"containedin=", the match will not start even if some ancestor would allow it.
Note that a |:syn-transparent| region still enforces its own |:syn-contains| list.
The {group-name}... can be used just like for "contains", as explained above. The {group-name}... can be used just like for "contains", as explained above.
This is useful when adding a syntax item afterwards. An item can be told to This is useful when adding a syntax item afterwards. An item can be told to
@ -4880,6 +4886,7 @@ Matches for "containedin" are added to the other places where the item can
appear. A "contains" argument may also be added as usual. Don't forget that appear. A "contains" argument may also be added as usual. Don't forget that
keywords never contain another item, thus adding them to "containedin" won't keywords never contain another item, thus adding them to "containedin" won't
work. work.
See also: |:syn-contains|, |:syn-transparent|.
nextgroup={group-name},.. *:syn-nextgroup* nextgroup={group-name},.. *:syn-nextgroup*