aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorChristian Clason <c.clason@uni-graz.at>2022-09-10 14:54:13 +0200
committerGitHub <noreply@github.com>2022-09-10 14:54:13 +0200
commit91a2e7a571c8615f2ffd9046687a6b438356db2b (patch)
tree802e0f70f6723283dc143f314357cf90ce72b7ab /runtime/doc
parent2a1c65b330c1cf65207cdd992529ad3bb1a197a4 (diff)
downloadrneovim-91a2e7a571c8615f2ffd9046687a6b438356db2b.tar.gz
rneovim-91a2e7a571c8615f2ffd9046687a6b438356db2b.tar.bz2
rneovim-91a2e7a571c8615f2ffd9046687a6b438356db2b.zip
vim-patch:71b6d3397649 (#20144)
Update runtime files https://github.com/vim/vim/commit/71b6d3397649fed68ef587aa863fcbdf5fdb057a
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/tagsrch.txt8
-rw-r--r--runtime/doc/userfunc.txt2
2 files changed, 6 insertions, 4 deletions
diff --git a/runtime/doc/tagsrch.txt b/runtime/doc/tagsrch.txt
index 2485290667..82deb0fa0c 100644
--- a/runtime/doc/tagsrch.txt
+++ b/runtime/doc/tagsrch.txt
@@ -870,13 +870,15 @@ like |CTRL-]|.
The function used for generating the taglist is specified by setting the
'tagfunc' option. The function will be called with three arguments:
- a:pattern The tag identifier or pattern used during the tag search.
- a:flags String containing flags to control the function behavior.
- a:info Dict containing the following entries:
+ pattern The tag identifier or pattern used during the tag search.
+ flags String containing flags to control the function behavior.
+ info Dict containing the following entries:
buf_ffname Full filename which can be used for priority.
user_data Custom data String, if stored in the tag
stack previously by tagfunc.
+Note that "a:" needs to be prepended to the argument name when using it.
+
Currently up to three flags may be passed to the tag function:
'c' The function was invoked by a normal command being processed
(mnemonic: the tag function may use the context around the
diff --git a/runtime/doc/userfunc.txt b/runtime/doc/userfunc.txt
index 39c246e21d..c701834383 100644
--- a/runtime/doc/userfunc.txt
+++ b/runtime/doc/userfunc.txt
@@ -20,7 +20,7 @@ commands can be executed with the |:normal| command.
The function name must start with an uppercase letter, to avoid confusion with
builtin functions. To prevent from using the same name in different scripts
-make them script-local. If you do use a global function the avoid obvious,
+make them script-local. If you do use a global function then avoid obvious,
short names. A good habit is to start the function name with the name of the
script, e.g., "HTMLcolor()".