Skip to content

Commit

Permalink
runtime(doc) Update help text for matchbufline() and matchstrlist()
Browse files Browse the repository at this point in the history
closes: #14080

Signed-off-by: Yegappan Lakshmanan <yegappan@yahoo.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
  • Loading branch information
yegappan authored and chrisbra committed Feb 24, 2024
1 parent aa31346 commit a35235e
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
9 changes: 8 additions & 1 deletion runtime/doc/builtin.txt
@@ -1,4 +1,4 @@
*builtin.txt* For Vim version 9.1. Last change: 2024 Feb 22
*builtin.txt* For Vim version 9.1. Last change: 2024 Feb 24


VIM REFERENCE MANUAL by Bram Moolenaar
Expand Down Expand Up @@ -6090,6 +6090,7 @@ match({expr}, {pat} [, {start} [, {count}]]) *match()*
Note that when {count} is added the way {start} works changes,
see above.

*match-pattern*
See |pattern| for the patterns that are accepted.
The 'ignorecase' option is used to set the ignore-caseness of
the pattern. 'smartcase' is NOT used. The matching is always
Expand Down Expand Up @@ -6237,6 +6238,9 @@ matchbufline({buf}, {pat}, {lnum}, {end}, [, {dict}])
This function works only for loaded buffers. First call
|bufload()| if needed.

See |match-pattern| for information about the effect of some
option settings on the pattern.

When {buf} is not a valid buffer, the buffer is not loaded or
{lnum} or {end} is not valid then an error is given and an
empty |List| is returned.
Expand Down Expand Up @@ -6411,6 +6415,9 @@ matchstrlist({list}, {pat} [, {dict}])
submatches a List of submatches. Present only if
"submatches" is set to v:true in {dict}.

See |match-pattern| for information about the effect of some
option settings on the pattern.

Example: >
:echo matchstrlist(['tik tok'], '\<\k\+\>')
[{'idx': 0, 'byteidx': 0, 'text': 'tik'}, {'idx': 0, 'byteidx': 4, 'text': 'tok'}]
Expand Down
1 change: 1 addition & 0 deletions runtime/doc/tags
Expand Up @@ -8615,6 +8615,7 @@ masm.vim syntax.txt /*masm.vim*
match() builtin.txt /*match()*
match-highlight pattern.txt /*match-highlight*
match-parens tips.txt /*match-parens*
match-pattern builtin.txt /*match-pattern*
matchadd() builtin.txt /*matchadd()*
matchaddpos() builtin.txt /*matchaddpos()*
matcharg() builtin.txt /*matcharg()*
Expand Down

0 comments on commit a35235e

Please sign in to comment.