aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorLewis Russell <lewis6991@gmail.com>2023-08-08 11:58:29 +0100
committerGitHub <noreply@github.com>2023-08-08 11:58:29 +0100
commit37c58226a8fd02afe9836f2fe43b31570fc50bb9 (patch)
treebb1405a4f6e2f6175f67fc64cb196fedefb9b507 /runtime/doc
parent11ad8fa4cd4d8e834d7b34a24f01e25579f6a89d (diff)
downloadrneovim-37c58226a8fd02afe9836f2fe43b31570fc50bb9.tar.gz
rneovim-37c58226a8fd02afe9836f2fe43b31570fc50bb9.tar.bz2
rneovim-37c58226a8fd02afe9836f2fe43b31570fc50bb9.zip
fix(lua): vim.fs typing (#24608)
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/lua.txt18
1 files changed, 10 insertions, 8 deletions
diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt
index bee3a761f3..efde69c8f4 100644
--- a/runtime/doc/lua.txt
+++ b/runtime/doc/lua.txt
@@ -2884,11 +2884,11 @@ vim.fs.find({names}, {opts}) *vim.fs.find()*
<
Parameters: ~
- • {names} (string|table|fun(name: string, path: string): boolean) Names
- of the items to find. Must be base names, paths and globs are
- not supported when {names} is a string or a table. If {names}
- is a function, it is called for each traversed item with
- args:
+ • {names} (string|string[]|fun(name: string, path: string): boolean)
+ Names of the items to find. Must be base names, paths and
+ globs are not supported when {names} is a string or a table.
+ If {names} is a function, it is called for each traversed
+ item with args:
• name: base name of the current item
• path: full path of the current item The function should
return `true` if the given item is considered a match.
@@ -2907,7 +2907,7 @@ vim.fs.find({names}, {opts}) *vim.fs.find()*
number of matches.
Return: ~
- (table) Normalized paths |vim.fs.normalize()| of all matching items
+ (string[]) Normalized paths |vim.fs.normalize()| of all matching items
vim.fs.joinpath({...}) *vim.fs.joinpath()*
Concatenate directories and/or file paths into a single path with
@@ -2967,8 +2967,10 @@ vim.fs.parents({start}) *vim.fs.parents()*
Parameters: ~
• {start} (string) Initial path.
- Return: ~
- (function) Iterator
+ Return (multiple): ~
+ fun(_, dir: string): string? Iterator
+ nil
+ (string|nil)
==============================================================================