aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/lua.txt
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2024-10-04 08:12:17 -0700
committerGitHub <noreply@github.com>2024-10-04 08:12:17 -0700
commit9a5bbaf813df598fafb7456c44d528e02648c1d8 (patch)
tree82e9cb944e46bcd14b762e6112f5e897f8e3b14f /runtime/doc/lua.txt
parent49b1af4e240847d454477e8bfeb8267255005e0d (diff)
downloadrneovim-9a5bbaf813df598fafb7456c44d528e02648c1d8.tar.gz
rneovim-9a5bbaf813df598fafb7456c44d528e02648c1d8.tar.bz2
rneovim-9a5bbaf813df598fafb7456c44d528e02648c1d8.zip
docs: more `@since` annotations #30660
Diffstat (limited to 'runtime/doc/lua.txt')
-rw-r--r--runtime/doc/lua.txt26
1 files changed, 26 insertions, 0 deletions
diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt
index fbd8da93bc..de0c6f27b5 100644
--- a/runtime/doc/lua.txt
+++ b/runtime/doc/lua.txt
@@ -2910,6 +2910,9 @@ Lua module: vim.fs *vim.fs*
vim.fs.basename({file}) *vim.fs.basename()*
Return the basename of the given path
+ Attributes: ~
+ Since: 0.8.0
+
Parameters: ~
• {file} (`string?`) Path
@@ -2919,6 +2922,9 @@ vim.fs.basename({file}) *vim.fs.basename()*
vim.fs.dir({path}, {opts}) *vim.fs.dir()*
Return an iterator over the items located in {path}
+ Attributes: ~
+ Since: 0.8.0
+
Parameters: ~
• {path} (`string`) An absolute or relative path to the directory to
iterate over. The path is first normalized
@@ -2938,6 +2944,9 @@ vim.fs.dir({path}, {opts}) *vim.fs.dir()*
vim.fs.dirname({file}) *vim.fs.dirname()*
Return the parent directory of the given path
+ Attributes: ~
+ Since: 0.8.0
+
Parameters: ~
• {file} (`string?`) Path
@@ -2970,6 +2979,9 @@ vim.fs.find({names}, {opts}) *vim.fs.find()*
end, {limit = math.huge, type = 'file'})
<
+ Attributes: ~
+ Since: 0.8.0
+
Parameters: ~
• {names} (`string|string[]|fun(name: string, path: string): boolean`)
Names of the items to find. Must be base names, paths and
@@ -3001,6 +3013,9 @@ vim.fs.joinpath({...}) *vim.fs.joinpath()*
Concatenate directories and/or file paths into a single path with
normalization (e.g., `"foo/"` and `"bar"` get joined to `"foo/bar"`)
+ Attributes: ~
+ Since: 0.10.0
+
Parameters: ~
• {...} (`string`)
@@ -3037,6 +3052,9 @@ vim.fs.normalize({path}, {opts}) *vim.fs.normalize()*
[[\\?\UNC\server\share\foo\..\..\..\bar]] => "//?/UNC/server/share/bar"
<
+ Attributes: ~
+ Since: 0.8.0
+
Parameters: ~
• {path} (`string`) Path to normalize
• {opts} (`table?`) A table with the following fields:
@@ -3065,6 +3083,9 @@ vim.fs.parents({start}) *vim.fs.parents()*
end
<
+ Attributes: ~
+ Since: 0.8.0
+
Parameters: ~
• {start} (`string`) Initial path.
@@ -3074,6 +3095,8 @@ vim.fs.parents({start}) *vim.fs.parents()*
(`string?`)
vim.fs.rm({path}, {opts}) *vim.fs.rm()*
+ WARNING: This feature is experimental/unstable.
+
Remove files or directories
Parameters: ~
@@ -3103,6 +3126,9 @@ vim.fs.root({source}, {marker}) *vim.fs.root()*
end)
<
+ Attributes: ~
+ Since: 0.10.0
+
Parameters: ~
• {source} (`integer|string`) Buffer number (0 for current buffer) or
file path (absolute or relative to the |current-directory|)