neovim

commit 4b98d3887064ddc242d917328d8014d2576b98f6
parent 4c5bce9cb417cf1c6a93cdd5ca6d3d52d2bf95d6
Author: zeertzjq <zeertzjq@outlook.com>
Date:   Wed, 11 Sep 2024 06:09:58 +0800

vim-patch:d657d3d: runtime(doc): clarify the effect of the timeout for search()-functions (#30337)

related: vim/vim#15657
related: vim/vim#15404

https://github.com/vim/vim/commit/d657d3d8fd635dbd78402358788dc58a96d04117

Co-authored-by: Christian Brabandt <cb@256bit.org>
Diffstat:
M
runtime/doc/builtin.txt
 | 
3
+++
M
runtime/lua/vim/_meta/vimfn.lua
 | 
3
+++
M
src/nvim/eval.lua
 | 
3
+++

3 files changed, 9 insertions(+), 0 deletions(-)
diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt
@@ -6201,6 +6201,9 @@ search({pattern} [, {flags} [, {stopline} [, {timeout} [, {skip}]]]]) *search()*
 		The value must not be negative.  A zero value is like not
 		giving the argument.
 
+		Note: the timeout is only considered when searching, not
+		while evaluating the {skip} expression.
+
 		If the {skip} expression is given it is evaluated with the
 		cursor positioned on the start of a match.  If it evaluates to
 		non-zero this match is skipped.  This can be used, for
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
@@ -7421,6 +7421,9 @@ function vim.fn.screenstring(row, col) end
 --- The value must not be negative.  A zero value is like not
 --- giving the argument.
 ---
+--- Note: the timeout is only considered when searching, not
+--- while evaluating the {skip} expression.
+---
 --- If the {skip} expression is given it is evaluated with the
 --- cursor positioned on the start of a match.  If it evaluates to
 --- non-zero this match is skipped.  This can be used, for
diff --git a/src/nvim/eval.lua b/src/nvim/eval.lua
@@ -8927,6 +8927,9 @@ M.funcs = {
       The value must not be negative.  A zero value is like not
       giving the argument.
 
+      Note: the timeout is only considered when searching, not
+      while evaluating the {skip} expression.
+
       If the {skip} expression is given it is evaluated with the
       cursor positioned on the start of a match.  If it evaluates to
       non-zero this match is skipped.  This can be used, for