aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc Jakobi <marc.jakobi@tiko.energy>2023-08-02 20:22:44 +0200
committerGitHub <noreply@github.com>2023-08-02 11:22:44 -0700
commit4a06de40e7c5bfe3be8f243b23b1676034fc6b08 (patch)
treebb6d29b87342dc51bc78bb4f92fc3894f5c54610
parent1ee905a63aa9f3d6873ec75a0954866d8660699e (diff)
downloadrneovim-4a06de40e7c5bfe3be8f243b23b1676034fc6b08.tar.gz
rneovim-4a06de40e7c5bfe3be8f243b23b1676034fc6b08.tar.bz2
rneovim-4a06de40e7c5bfe3be8f243b23b1676034fc6b08.zip
docs(lua): fix generated `fname` param annotations #24533
-rw-r--r--runtime/lua/vim/_meta/vimfn.lua22
-rw-r--r--src/nvim/eval.lua22
2 files changed, 22 insertions, 22 deletions
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index b15d780121..bb11e34a57 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -1315,7 +1315,7 @@ function vim.fn.deepcopy(expr, noref) end
--- operation was successful and -1/true when the deletion failed
--- or partly failed.
---
---- @param fname integer
+--- @param fname string
--- @param flags? string
--- @return integer
function vim.fn.delete(fname, flags) end
@@ -2222,7 +2222,7 @@ function vim.fn.fnameescape(string) end
--- Note: Environment variables don't work in {fname}, use
--- |expand()| first then.
---
---- @param fname integer
+--- @param fname string
--- @param mods string
--- @return string
function vim.fn.fnamemodify(fname, mods) end
@@ -3029,7 +3029,7 @@ function vim.fn.getfontname(name) end
---
--- For setting permissions use |setfperm()|.
---
---- @param fname integer
+--- @param fname string
--- @return string
function vim.fn.getfperm(fname) end
@@ -3040,7 +3040,7 @@ function vim.fn.getfperm(fname) end
--- If the size of {fname} is too big to fit in a Number then -2
--- is returned.
---
---- @param fname integer
+--- @param fname string
--- @return integer
function vim.fn.getfsize(fname) end
@@ -3050,7 +3050,7 @@ function vim.fn.getfsize(fname) end
--- |localtime()| and |strftime()|.
--- If the file {fname} can't be found -1 is returned.
---
---- @param fname integer
+--- @param fname string
--- @return integer
function vim.fn.getftime(fname) end
@@ -3073,7 +3073,7 @@ function vim.fn.getftime(fname) end
--- systems that support it. On some systems only "dir" and
--- "file" are returned.
---
---- @param fname integer
+--- @param fname string
--- @return 'file'|'dir'|'link'|'bdev'|'cdev'|'socket'|'fifo'|'other'
function vim.fn.getftype(fname) end
@@ -6339,7 +6339,7 @@ function vim.fn.range(expr, max, stride) end
--- is truncated.
--- Also see |readfile()| and |writefile()|.
---
---- @param fname integer
+--- @param fname string
--- @param offset? any
--- @param size? any
--- @return any
@@ -6411,7 +6411,7 @@ function vim.fn.readdir(directory, expr) end
--- the result is an empty list.
--- Also see |writefile()|.
---
---- @param fname integer
+--- @param fname string
--- @param type? any
--- @param max? any
--- @return any
@@ -7441,7 +7441,7 @@ function vim.fn.setenv(name, val) end
---
--- To read permissions see |getfperm()|.
---
---- @param fname integer
+--- @param fname string
--- @param mode string
--- @return any
function vim.fn.setfperm(fname, mode) end
@@ -9127,7 +9127,7 @@ function vim.fn.swapfilelist() end
--- Not a swap file: does not contain correct block ID
--- Magic number mismatch: Info in first block is invalid
---
---- @param fname integer
+--- @param fname string
--- @return any
function vim.fn.swapinfo(fname) end
@@ -10391,7 +10391,7 @@ function vim.fn.wordcount() end
--- call writefile(fl, "foocopy", "b")
---
--- @param object any
---- @param fname integer
+--- @param fname string
--- @param flags? string
--- @return any
function vim.fn.writefile(object, fname, flags) end
diff --git a/src/nvim/eval.lua b/src/nvim/eval.lua
index b937829658..907993ddca 100644
--- a/src/nvim/eval.lua
+++ b/src/nvim/eval.lua
@@ -1728,7 +1728,7 @@ M.funcs = {
]=],
name = 'delete',
- params = { { 'fname', 'integer' }, { 'flags', 'string' } },
+ params = { { 'fname', 'string' }, { 'flags', 'string' } },
returns = 'integer',
signature = 'delete({fname} [, {flags}])',
},
@@ -2799,7 +2799,7 @@ M.funcs = {
]=],
fast = true,
name = 'fnamemodify',
- params = { { 'fname', 'integer' }, { 'mods', 'string' } },
+ params = { { 'fname', 'string' }, { 'mods', 'string' } },
returns = 'string',
signature = 'fnamemodify({fname}, {mods})',
},
@@ -3767,7 +3767,7 @@ M.funcs = {
]=],
fast = true,
name = 'getfperm',
- params = { { 'fname', 'integer' } },
+ params = { { 'fname', 'string' } },
returns = 'string',
signature = 'getfperm({fname})',
},
@@ -3785,7 +3785,7 @@ M.funcs = {
]=],
fast = true,
name = 'getfsize',
- params = { { 'fname', 'integer' } },
+ params = { { 'fname', 'string' } },
returns = 'integer',
signature = 'getfsize({fname})',
},
@@ -3802,7 +3802,7 @@ M.funcs = {
]=],
fast = true,
name = 'getftime',
- params = { { 'fname', 'integer' } },
+ params = { { 'fname', 'string' } },
returns = 'integer',
signature = 'getftime({fname})',
},
@@ -3832,7 +3832,7 @@ M.funcs = {
]=],
fast = true,
name = 'getftype',
- params = { { 'fname', 'integer' } },
+ params = { { 'fname', 'string' } },
returns = "'file'|'dir'|'link'|'bdev'|'cdev'|'socket'|'fifo'|'other'",
signature = 'getftype({fname})',
},
@@ -7649,7 +7649,7 @@ M.funcs = {
Also see |readfile()| and |writefile()|.
]=],
name = 'readblob',
- params = { { 'fname', 'integer' }, { 'offset', 'any' }, { 'size', 'any' } },
+ params = { { 'fname', 'string' }, { 'offset', 'any' }, { 'size', 'any' } },
signature = 'readblob({fname} [, {offset} [, {size}]])',
},
readdir = {
@@ -7728,7 +7728,7 @@ M.funcs = {
]=],
name = 'readfile',
- params = { { 'fname', 'integer' }, { 'type', 'any' }, { 'max', 'any' } },
+ params = { { 'fname', 'string' }, { 'type', 'any' }, { 'max', 'any' } },
signature = 'readfile({fname} [, {type} [, {max}]])',
},
reduce = {
@@ -8948,7 +8948,7 @@ M.funcs = {
To read permissions see |getfperm()|.
]=],
name = 'setfperm',
- params = { { 'fname', 'integer' }, { 'mode', 'string' } },
+ params = { { 'fname', 'string' }, { 'mode', 'string' } },
signature = 'setfperm({fname}, {mode})',
},
setline = {
@@ -10870,7 +10870,7 @@ M.funcs = {
]=],
name = 'swapinfo',
- params = { { 'fname', 'integer' } },
+ params = { { 'fname', 'string' } },
signature = 'swapinfo({fname})',
},
swapname = {
@@ -12406,7 +12406,7 @@ M.funcs = {
]=],
name = 'writefile',
- params = { { 'object', 'any' }, { 'fname', 'integer' }, { 'flags', 'string' } },
+ params = { { 'object', 'any' }, { 'fname', 'string' }, { 'flags', 'string' } },
signature = 'writefile({object}, {fname} [, {flags}])',
},
xor = {