docs(lua): fix generated fname param annotations #24533

This commit is contained in:
Marc Jakobi
2023-08-02 20:22:44 +02:00
committed by GitHub
parent 1ee905a63a
commit 4a06de40e7
2 changed files with 22 additions and 22 deletions

View File

@@ -1315,7 +1315,7 @@ function vim.fn.deepcopy(expr, noref) end
--- operation was successful and -1/true when the deletion failed --- operation was successful and -1/true when the deletion failed
--- or partly failed. --- or partly failed.
--- ---
--- @param fname integer --- @param fname string
--- @param flags? string --- @param flags? string
--- @return integer --- @return integer
function vim.fn.delete(fname, flags) end 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 --- Note: Environment variables don't work in {fname}, use
--- |expand()| first then. --- |expand()| first then.
--- ---
--- @param fname integer --- @param fname string
--- @param mods string --- @param mods string
--- @return string --- @return string
function vim.fn.fnamemodify(fname, mods) end function vim.fn.fnamemodify(fname, mods) end
@@ -3029,7 +3029,7 @@ function vim.fn.getfontname(name) end
--- ---
--- For setting permissions use |setfperm()|. --- For setting permissions use |setfperm()|.
--- ---
--- @param fname integer --- @param fname string
--- @return string --- @return string
function vim.fn.getfperm(fname) end 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 --- If the size of {fname} is too big to fit in a Number then -2
--- is returned. --- is returned.
--- ---
--- @param fname integer --- @param fname string
--- @return integer --- @return integer
function vim.fn.getfsize(fname) end function vim.fn.getfsize(fname) end
@@ -3050,7 +3050,7 @@ function vim.fn.getfsize(fname) end
--- |localtime()| and |strftime()|. --- |localtime()| and |strftime()|.
--- If the file {fname} can't be found -1 is returned. --- If the file {fname} can't be found -1 is returned.
--- ---
--- @param fname integer --- @param fname string
--- @return integer --- @return integer
function vim.fn.getftime(fname) end 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 --- systems that support it. On some systems only "dir" and
--- "file" are returned. --- "file" are returned.
--- ---
--- @param fname integer --- @param fname string
--- @return 'file'|'dir'|'link'|'bdev'|'cdev'|'socket'|'fifo'|'other' --- @return 'file'|'dir'|'link'|'bdev'|'cdev'|'socket'|'fifo'|'other'
function vim.fn.getftype(fname) end function vim.fn.getftype(fname) end
@@ -6339,7 +6339,7 @@ function vim.fn.range(expr, max, stride) end
--- is truncated. --- is truncated.
--- Also see |readfile()| and |writefile()|. --- Also see |readfile()| and |writefile()|.
--- ---
--- @param fname integer --- @param fname string
--- @param offset? any --- @param offset? any
--- @param size? any --- @param size? any
--- @return any --- @return any
@@ -6411,7 +6411,7 @@ function vim.fn.readdir(directory, expr) end
--- the result is an empty list. --- the result is an empty list.
--- Also see |writefile()|. --- Also see |writefile()|.
--- ---
--- @param fname integer --- @param fname string
--- @param type? any --- @param type? any
--- @param max? any --- @param max? any
--- @return any --- @return any
@@ -7441,7 +7441,7 @@ function vim.fn.setenv(name, val) end
--- ---
--- To read permissions see |getfperm()|. --- To read permissions see |getfperm()|.
--- ---
--- @param fname integer --- @param fname string
--- @param mode string --- @param mode string
--- @return any --- @return any
function vim.fn.setfperm(fname, mode) end 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 --- Not a swap file: does not contain correct block ID
--- Magic number mismatch: Info in first block is invalid --- Magic number mismatch: Info in first block is invalid
--- ---
--- @param fname integer --- @param fname string
--- @return any --- @return any
function vim.fn.swapinfo(fname) end function vim.fn.swapinfo(fname) end
@@ -10391,7 +10391,7 @@ function vim.fn.wordcount() end
--- call writefile(fl, "foocopy", "b") --- call writefile(fl, "foocopy", "b")
--- ---
--- @param object any --- @param object any
--- @param fname integer --- @param fname string
--- @param flags? string --- @param flags? string
--- @return any --- @return any
function vim.fn.writefile(object, fname, flags) end function vim.fn.writefile(object, fname, flags) end

View File

@@ -1728,7 +1728,7 @@ M.funcs = {
]=], ]=],
name = 'delete', name = 'delete',
params = { { 'fname', 'integer' }, { 'flags', 'string' } }, params = { { 'fname', 'string' }, { 'flags', 'string' } },
returns = 'integer', returns = 'integer',
signature = 'delete({fname} [, {flags}])', signature = 'delete({fname} [, {flags}])',
}, },
@@ -2799,7 +2799,7 @@ M.funcs = {
]=], ]=],
fast = true, fast = true,
name = 'fnamemodify', name = 'fnamemodify',
params = { { 'fname', 'integer' }, { 'mods', 'string' } }, params = { { 'fname', 'string' }, { 'mods', 'string' } },
returns = 'string', returns = 'string',
signature = 'fnamemodify({fname}, {mods})', signature = 'fnamemodify({fname}, {mods})',
}, },
@@ -3767,7 +3767,7 @@ M.funcs = {
]=], ]=],
fast = true, fast = true,
name = 'getfperm', name = 'getfperm',
params = { { 'fname', 'integer' } }, params = { { 'fname', 'string' } },
returns = 'string', returns = 'string',
signature = 'getfperm({fname})', signature = 'getfperm({fname})',
}, },
@@ -3785,7 +3785,7 @@ M.funcs = {
]=], ]=],
fast = true, fast = true,
name = 'getfsize', name = 'getfsize',
params = { { 'fname', 'integer' } }, params = { { 'fname', 'string' } },
returns = 'integer', returns = 'integer',
signature = 'getfsize({fname})', signature = 'getfsize({fname})',
}, },
@@ -3802,7 +3802,7 @@ M.funcs = {
]=], ]=],
fast = true, fast = true,
name = 'getftime', name = 'getftime',
params = { { 'fname', 'integer' } }, params = { { 'fname', 'string' } },
returns = 'integer', returns = 'integer',
signature = 'getftime({fname})', signature = 'getftime({fname})',
}, },
@@ -3832,7 +3832,7 @@ M.funcs = {
]=], ]=],
fast = true, fast = true,
name = 'getftype', name = 'getftype',
params = { { 'fname', 'integer' } }, params = { { 'fname', 'string' } },
returns = "'file'|'dir'|'link'|'bdev'|'cdev'|'socket'|'fifo'|'other'", returns = "'file'|'dir'|'link'|'bdev'|'cdev'|'socket'|'fifo'|'other'",
signature = 'getftype({fname})', signature = 'getftype({fname})',
}, },
@@ -7649,7 +7649,7 @@ M.funcs = {
Also see |readfile()| and |writefile()|. Also see |readfile()| and |writefile()|.
]=], ]=],
name = 'readblob', name = 'readblob',
params = { { 'fname', 'integer' }, { 'offset', 'any' }, { 'size', 'any' } }, params = { { 'fname', 'string' }, { 'offset', 'any' }, { 'size', 'any' } },
signature = 'readblob({fname} [, {offset} [, {size}]])', signature = 'readblob({fname} [, {offset} [, {size}]])',
}, },
readdir = { readdir = {
@@ -7728,7 +7728,7 @@ M.funcs = {
]=], ]=],
name = 'readfile', name = 'readfile',
params = { { 'fname', 'integer' }, { 'type', 'any' }, { 'max', 'any' } }, params = { { 'fname', 'string' }, { 'type', 'any' }, { 'max', 'any' } },
signature = 'readfile({fname} [, {type} [, {max}]])', signature = 'readfile({fname} [, {type} [, {max}]])',
}, },
reduce = { reduce = {
@@ -8948,7 +8948,7 @@ M.funcs = {
To read permissions see |getfperm()|. To read permissions see |getfperm()|.
]=], ]=],
name = 'setfperm', name = 'setfperm',
params = { { 'fname', 'integer' }, { 'mode', 'string' } }, params = { { 'fname', 'string' }, { 'mode', 'string' } },
signature = 'setfperm({fname}, {mode})', signature = 'setfperm({fname}, {mode})',
}, },
setline = { setline = {
@@ -10870,7 +10870,7 @@ M.funcs = {
]=], ]=],
name = 'swapinfo', name = 'swapinfo',
params = { { 'fname', 'integer' } }, params = { { 'fname', 'string' } },
signature = 'swapinfo({fname})', signature = 'swapinfo({fname})',
}, },
swapname = { swapname = {
@@ -12406,7 +12406,7 @@ M.funcs = {
]=], ]=],
name = 'writefile', name = 'writefile',
params = { { 'object', 'any' }, { 'fname', 'integer' }, { 'flags', 'string' } }, params = { { 'object', 'any' }, { 'fname', 'string' }, { 'flags', 'string' } },
signature = 'writefile({object}, {fname} [, {flags}])', signature = 'writefile({object}, {fname} [, {flags}])',
}, },
xor = { xor = {