commit ddcfa8bb4a98402c76c2996c6248c699095c05e6
parent 1bafba31f6a6d8cd367e1388e22013f3f7d0331e
Author: zeertzjq <zeertzjq@outlook.com>
Date: Tue, 16 Sep 2025 07:31:21 +0800
vim-patch:8e0d374: runtime(doc): Improve the doc for :syn-containedin (#35785)
closes: vim/vim#18290
https://github.com/vim/vim/commit/8e0d374e4d3f1be11e64010d69b6d9a5e913ec8d
Co-authored-by: Damien Lejay <damien@lejay.be>
Co-authored-by: h_east <h.east.727@gmail.com>
Diffstat:
1 file changed, 7 insertions(+), 0 deletions(-)
diff --git a/runtime/doc/syntax.txt b/runtime/doc/syntax.txt
@@ -4336,6 +4336,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
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.
This is useful when adding a syntax item afterwards. An item can be told to
@@ -4350,6 +4356,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
keywords never contain another item, thus adding them to "containedin" won't
work.
+See also: |:syn-contains|, |:syn-transparent|.
nextgroup={group-name},.. *:syn-nextgroup*
