neovim

commit 1bfb8dd338f4c13ca2fea78d241a852931f1bed0
parent db702782e0168d45256a975c4bc1809b5785d952
Author: zeertzjq <zeertzjq@outlook.com>
Date:   Sat, 10 May 2025 07:11:36 +0800

vim-patch:17ad852: runtime(doc): update return types for builtin functions

fixes: vim/vim#17273

credit: Github user @msoyka2024

https://github.com/vim/vim/commit/17ad852a62b6e2cf25207292ebca7a748e529d59

Co-authored-by: Christian Brabandt <cb@256bit.org>

Diffstat:
M
runtime/doc/builtin.txt
 | 
10
+++++++---
M
runtime/lua/vim/_meta/vimfn.lua
 | 
10
+++++++---
M
src/nvim/eval.lua
 | 
6
+++++-

3 files changed, 19 insertions(+), 7 deletions(-)
diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt
@@ -1528,6 +1528,8 @@ cursor({list})
 		position within a <Tab> or after the last character.
 		Returns 0 when the position could be set, -1 otherwise.
 
+		Returns 0 when the position could be set, -1 otherwise.
+
                 Parameters: ~
                   • {list} (`integer[]`)
 
@@ -2457,7 +2459,7 @@ finddir({name} [, {path} [, {count}]])                               *finddir()*
                   • {count} (`integer?`)
 
                 Return: ~
-                  (`any`)
+                  (`string|string[]`)
 
 findfile({name} [, {path} [, {count}]])                             *findfile()*
 		Just like |finddir()|, but find a file instead of a directory.
@@ -2470,10 +2472,10 @@ findfile({name} [, {path} [, {count}]])                             *findfile()*
                 Parameters: ~
                   • {name} (`string`)
                   • {path} (`string?`)
-                  • {count} (`any?`)
+                  • {count} (`integer?`)
 
                 Return: ~
-                  (`any`)
+                  (`string|string[]`)
 
 flatten({list} [, {maxdepth}])                                       *flatten()*
 		Flatten {list} up to {maxdepth} levels.  Without {maxdepth}
@@ -8942,6 +8944,8 @@ setcursorcharpos({list})
 			call cursor(4, 3)
 <		positions the cursor on the first character '여'.
 
+		Returns 0 when the position could be set, -1 otherwise.
+
                 Parameters: ~
                   • {list} (`integer[]`)
 
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
@@ -1350,6 +1350,8 @@ function vim.fn.cursor(lnum, col, off) end
 --- position within a <Tab> or after the last character.
 --- Returns 0 when the position could be set, -1 otherwise.
 ---
+--- Returns 0 when the position could be set, -1 otherwise.
+---
 --- @param list integer[]
 --- @return any
 function vim.fn.cursor(list) end
@@ -2197,7 +2199,7 @@ function vim.fn.filter(expr1, expr2) end
 --- @param name string
 --- @param path? string
 --- @param count? integer
---- @return any
+--- @return string|string[]
 function vim.fn.finddir(name, path, count) end
 
 --- Just like |finddir()|, but find a file instead of a directory.
@@ -2209,8 +2211,8 @@ function vim.fn.finddir(name, path, count) end
 ---
 --- @param name string
 --- @param path? string
---- @param count? any
---- @return any
+--- @param count? integer
+--- @return string|string[]
 function vim.fn.findfile(name, path, count) end
 
 --- Flatten {list} up to {maxdepth} levels.  Without {maxdepth}
@@ -8150,6 +8152,8 @@ function vim.fn.setcursorcharpos(lnum, col, off) end
 ---   call cursor(4, 3)
 --- <positions the cursor on the first character '여'.
 ---
+--- Returns 0 when the position could be set, -1 otherwise.
+---
 --- @param list integer[]
 --- @return any
 function vim.fn.setcursorcharpos(list) end
diff --git a/src/nvim/eval.lua b/src/nvim/eval.lua
@@ -1779,6 +1779,7 @@ M.funcs = {
       position within a <Tab> or after the last character.
       Returns 0 when the position could be set, -1 otherwise.
 
+      Returns 0 when the position could be set, -1 otherwise.
     ]=],
     name = 'cursor',
     params = { { 'list', 'integer[]' } },
@@ -2795,6 +2796,7 @@ M.funcs = {
     ]=],
     name = 'finddir',
     params = { { 'name', 'string' }, { 'path', 'string' }, { 'count', 'integer' } },
+    returns = 'string|string[]',
     signature = 'finddir({name} [, {path} [, {count}]])',
   },
   findfile = {
@@ -2810,7 +2812,8 @@ M.funcs = {
 
     ]=],
     name = 'findfile',
-    params = { { 'name', 'string' }, { 'path', 'string' }, { 'count', 'any' } },
+    params = { { 'name', 'string' }, { 'path', 'string' }, { 'count', 'integer' } },
+    returns = 'string|string[]',
     signature = 'findfile({name} [, {path} [, {count}]])',
   },
   flatten = {
@@ -9872,6 +9875,7 @@ M.funcs = {
       	call cursor(4, 3)
       <positions the cursor on the first character '여'.
 
+      Returns 0 when the position could be set, -1 otherwise.
     ]=],
     name = 'setcursorcharpos',
     params = { { 'list', 'integer[]' } },