aniani/vim
0
0
Fork 1
mirror of https://github.com/vim/vim.git synced 2025-08-26 20:03:41 -04:00
Code

runtime(doc): update return types for builtin functions

Browse Source 
fixes: #17273

credit: Github user @msoyka2024
Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
Christian Brabandt 2025-05-09 00:03:20 +02:00
parent dc314053e1
commit 17ad852a62
No known key found for this signature in database
GPG Key ID: F3F92DA383FDDE09
1 changed files with 6 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
runtime/doc/builtin.txt
View File

@ -1,4 +1,4 @@
*builtin.txt* For Vim version 9.1. Last change: 2025 Apr 27 *builtin.txt* For Vim version 9.1. Last change: 2025 May 08
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -194,9 +194,8 @@ filter({expr1}, {expr2}) List/Dict/Blob/String
remove items from {expr1} where remove items from {expr1} where
{expr2} is 0 {expr2} is 0
finddir({name} [, {path} [, {count}]]) finddir({name} [, {path} [, {count}]])
String find directory {name} in {path}
findfile({name} [, {path} [, {count}]]) findfile({name} [, {path} [, {count}]])
String find file {name} in {path} String/List find dir/file {name} in {path}
flatten({list} [, {maxdepth}]) List flatten {list} up to {maxdepth} levels flatten({list} [, {maxdepth}]) List flatten {list} up to {maxdepth} levels
flattennew({list} [, {maxdepth}]) flattennew({list} [, {maxdepth}])
List flatten a copy of {list} List flatten a copy of {list}
@ -2286,6 +2285,7 @@ cursor({list})
Can also be used as a |method|: > Can also be used as a |method|: >
GetCursorPos()->cursor() GetCursorPos()->cursor()
< <
Returns 0 when the position could be set, -1 otherwise.
Return type: |Number| Return type: |Number|
@ -3167,7 +3167,7 @@ feedkeys({string} [, {mode}]) *feedkeys()*
Can also be used as a |method|: > Can also be used as a |method|: >
GetInput()->feedkeys() GetInput()->feedkeys()
< <
Return type: |String| or list<string> depending on {list} Return type: |Number|
filecopy({from}, {to}) *filecopy()* filecopy({from}, {to}) *filecopy()*
@ -4962,7 +4962,7 @@ getreg([{regname} [, 1 [, {list}]]]) *getreg()*
Can also be used as a |method|: > Can also be used as a |method|: >
GetRegname()->getreg() GetRegname()->getreg()
< <
Return type: |String| Return type: |String| or list<string> depending on {list}
getreginfo([{regname}]) *getreginfo()* getreginfo([{regname}]) *getreginfo()*
@ -9828,6 +9828,7 @@ setcursorcharpos({list})
Can also be used as a |method|: > Can also be used as a |method|: >
GetCursorPos()->setcursorcharpos() GetCursorPos()->setcursorcharpos()
< <
Returns 0 when the position could be set, -1 otherwise.
Return type: |Number| Return type: |Number|