mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-09-11 13:58:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(eval): fix lnum type for functions using tv_get_lnum

Browse Source 
These occurrences also accept string, which is used like in getline.

Also make the lnum field of vim.fn.sign_placelist.list.item optional, as it can
be omitted like vim.fn.sign_place.dict's.

(cherry picked from commit 4a36f234ac)
This commit is contained in:
Sean Dewar
2025-03-31 21:02:04 +01:00
committed by github-actions[bot]
parent 326eacef93
commit 09fd22d5d7
4 changed files with 56 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
runtime/doc/builtin.txt generated
View File

@@ -110,7 +110,7 @@ append({lnum}, {text}) *append()*
< <
Parameters: ~ Parameters: ~
• {lnum} (`integer`) • {lnum} (`integer|string`)
• {text} (`string|string[]`) • {text} (`string|string[]`)
Return: ~ Return: ~
@@ -1047,7 +1047,7 @@ cindent({lnum}) *cindent()*
To get or set indent of lines in a string, see |vim.text.indent()|. To get or set indent of lines in a string, see |vim.text.indent()|.
Parameters: ~ Parameters: ~
• {lnum} (`integer`) • {lnum} (`integer|string`)
Return: ~ Return: ~
(`integer`) (`integer`)
@@ -1637,7 +1637,7 @@ diff_filler({lnum}) *diff_filler()*
Returns 0 if the current window is not in diff mode. Returns 0 if the current window is not in diff mode.
Parameters: ~ Parameters: ~
• {lnum} (`integer`) • {lnum} (`integer|string`)
Return: ~ Return: ~
(`integer`) (`integer`)
@@ -1654,7 +1654,7 @@ diff_hlID({lnum}, {col}) *diff_hlID()*
syntax information about the highlighting. syntax information about the highlighting.
Parameters: ~ Parameters: ~
• {lnum} (`integer`) • {lnum} (`integer|string`)
• {col} (`integer`) • {col} (`integer`)
Return: ~ Return: ~
@@ -2563,7 +2563,7 @@ foldclosed({lnum}) *foldclosed()*
line, "'m" mark m, etc. line, "'m" mark m, etc.
Parameters: ~ Parameters: ~
• {lnum} (`integer`) • {lnum} (`integer|string`)
Return: ~ Return: ~
(`integer`) (`integer`)
@@ -2576,7 +2576,7 @@ foldclosedend({lnum}) *foldclosedend()*
line, "'m" mark m, etc. line, "'m" mark m, etc.
Parameters: ~ Parameters: ~
• {lnum} (`integer`) • {lnum} (`integer|string`)
Return: ~ Return: ~
(`integer`) (`integer`)
@@ -2594,7 +2594,7 @@ foldlevel({lnum}) *foldlevel()*
line, "'m" mark m, etc. line, "'m" mark m, etc.
Parameters: ~ Parameters: ~
• {lnum} (`integer`) • {lnum} (`integer|string`)
Return: ~ Return: ~
(`integer`) (`integer`)
@@ -2629,7 +2629,7 @@ foldtextresult({lnum}) *foldtextresult()*
Useful when exporting folded text, e.g., to HTML. Useful when exporting folded text, e.g., to HTML.
Parameters: ~ Parameters: ~
• {lnum} (`integer`) • {lnum} (`integer|string`)
Return: ~ Return: ~
(`string`) (`string`)
@@ -5706,7 +5706,7 @@ line2byte({lnum}) *line2byte()*
Also see |byte2line()|, |go| and |:goto|. Also see |byte2line()|, |go| and |:goto|.
Parameters: ~ Parameters: ~
• {lnum} (`integer`) • {lnum} (`integer|string`)
Return: ~ Return: ~
(`integer`) (`integer`)
@@ -5719,7 +5719,7 @@ lispindent({lnum}) *lispindent()*
When {lnum} is invalid, -1 is returned. When {lnum} is invalid, -1 is returned.
Parameters: ~ Parameters: ~
• {lnum} (`integer`) • {lnum} (`integer|string`)
Return: ~ Return: ~
(`integer`) (`integer`)
@@ -6990,7 +6990,7 @@ nextnonblank({lnum}) *nextnonblank()*
See also |prevnonblank()|. See also |prevnonblank()|.
Parameters: ~ Parameters: ~
• {lnum} (`integer`) • {lnum} (`integer|string`)
Return: ~ Return: ~
(`integer`) (`integer`)
@@ -7124,7 +7124,7 @@ prevnonblank({lnum}) *prevnonblank()*
Also see |nextnonblank()|. Also see |nextnonblank()|.
Parameters: ~ Parameters: ~
• {lnum} (`integer`) • {lnum} (`integer|string`)
Return: ~ Return: ~
(`integer`) (`integer`)
@@ -8937,7 +8937,7 @@ setline({lnum}, {text}) *setline()*
< Note: The '[ and '] marks are not set. < Note: The '[ and '] marks are not set.
Parameters: ~ Parameters: ~
• {lnum} (`integer`) • {lnum} (`integer|string`)
• {text} (`any`) • {text} (`any`)
Return: ~ Return: ~
@@ -10851,7 +10851,7 @@ synID({lnum}, {col}, {trans}) *synID()*
< <
Parameters: ~ Parameters: ~
• {lnum} (`integer`) • {lnum} (`integer|string`)
• {col} (`integer`) • {col} (`integer`)
• {trans} (`0|1`) • {trans} (`0|1`)
@@ -10956,7 +10956,7 @@ synconcealed({lnum}, {col}) *synconcealed()*
mechanisms |syntax-vs-match|. mechanisms |syntax-vs-match|.
Parameters: ~ Parameters: ~
• {lnum} (`integer`) • {lnum} (`integer|string`)
• {col} (`integer`) • {col} (`integer`)
Return: ~ Return: ~
@@ -10982,7 +10982,7 @@ synstack({lnum}, {col}) *synstack()*
valid positions. valid positions.
Parameters: ~ Parameters: ~
• {lnum} (`integer`) • {lnum} (`integer|string`)
• {col} (`integer`) • {col} (`integer`)
Return: ~ Return: ~

4
runtime/lua/vim/_meta/builtin_types.lua
View File

@@ -184,14 +184,14 @@
--- @field signs vim.fn.sign[] --- @field signs vim.fn.sign[]
--- @class vim.fn.sign_place.dict --- @class vim.fn.sign_place.dict
--- @field lnum? integer --- @field lnum? integer|string
--- @field priority? integer --- @field priority? integer
--- @class vim.fn.sign_placelist.list.item --- @class vim.fn.sign_placelist.list.item
--- @field buffer integer|string --- @field buffer integer|string
--- @field group? string --- @field group? string
--- @field id? integer --- @field id? integer
--- @field lnum integer --- @field lnum? integer|string
--- @field name string --- @field name string
--- @field priority? integer --- @field priority? integer

38
runtime/lua/vim/_meta/vimfn.lua generated
View File

@@ -85,7 +85,7 @@ function vim.fn.api_info() end
--- let failed = append(0, ["Chapter 1", "the beginning"]) --- let failed = append(0, ["Chapter 1", "the beginning"])
--- < --- <
--- ---
--- @param lnum integer --- @param lnum integer|string
--- @param text string|string[] --- @param text string|string[]
--- @return 0|1 --- @return 0|1
function vim.fn.append(lnum, text) end function vim.fn.append(lnum, text) end
@@ -907,7 +907,7 @@ function vim.fn.chdir(dir) end
--- ---
--- To get or set indent of lines in a string, see |vim.text.indent()|. --- To get or set indent of lines in a string, see |vim.text.indent()|.
--- ---
--- @param lnum integer --- @param lnum integer|string
--- @return integer --- @return integer
function vim.fn.cindent(lnum) end function vim.fn.cindent(lnum) end
@@ -1244,7 +1244,7 @@ function vim.fn.ctxset(context, index) end
--- @return any --- @return any
function vim.fn.ctxsize() end function vim.fn.ctxsize() end
--- @param lnum integer --- @param lnum integer|string
--- @param col? integer --- @param col? integer
--- @param off? integer --- @param off? integer
--- @return any --- @return any
@@ -1441,7 +1441,7 @@ function vim.fn.did_filetype() end
--- line, "'m" mark m, etc. --- line, "'m" mark m, etc.
--- Returns 0 if the current window is not in diff mode. --- Returns 0 if the current window is not in diff mode.
--- ---
--- @param lnum integer --- @param lnum integer|string
--- @return integer --- @return integer
function vim.fn.diff_filler(lnum) end function vim.fn.diff_filler(lnum) end
@@ -1455,7 +1455,7 @@ function vim.fn.diff_filler(lnum) end
--- The highlight ID can be used with |synIDattr()| to obtain --- The highlight ID can be used with |synIDattr()| to obtain
--- syntax information about the highlighting. --- syntax information about the highlighting.
--- ---
--- @param lnum integer --- @param lnum integer|string
--- @param col integer --- @param col integer
--- @return any --- @return any
function vim.fn.diff_hlID(lnum, col) end function vim.fn.diff_hlID(lnum, col) end
@@ -2282,7 +2282,7 @@ function vim.fn.fnamemodify(fname, mods) end
--- {lnum} is used like with |getline()|. Thus "." is the current --- {lnum} is used like with |getline()|. Thus "." is the current
--- line, "'m" mark m, etc. --- line, "'m" mark m, etc.
--- ---
--- @param lnum integer --- @param lnum integer|string
--- @return integer --- @return integer
function vim.fn.foldclosed(lnum) end function vim.fn.foldclosed(lnum) end
@@ -2292,7 +2292,7 @@ function vim.fn.foldclosed(lnum) end
--- {lnum} is used like with |getline()|. Thus "." is the current --- {lnum} is used like with |getline()|. Thus "." is the current
--- line, "'m" mark m, etc. --- line, "'m" mark m, etc.
--- ---
--- @param lnum integer --- @param lnum integer|string
--- @return integer --- @return integer
function vim.fn.foldclosedend(lnum) end function vim.fn.foldclosedend(lnum) end
@@ -2307,7 +2307,7 @@ function vim.fn.foldclosedend(lnum) end
--- {lnum} is used like with |getline()|. Thus "." is the current --- {lnum} is used like with |getline()|. Thus "." is the current
--- line, "'m" mark m, etc. --- line, "'m" mark m, etc.
--- ---
--- @param lnum integer --- @param lnum integer|string
--- @return integer --- @return integer
function vim.fn.foldlevel(lnum) end function vim.fn.foldlevel(lnum) end
@@ -2338,7 +2338,7 @@ function vim.fn.foldtext() end
--- line, "'m" mark m, etc. --- line, "'m" mark m, etc.
--- Useful when exporting folded text, e.g., to HTML. --- Useful when exporting folded text, e.g., to HTML.
--- ---
--- @param lnum integer --- @param lnum integer|string
--- @return string --- @return string
function vim.fn.foldtextresult(lnum) end function vim.fn.foldtextresult(lnum) end
@@ -3284,7 +3284,7 @@ function vim.fn.getjumplist(winnr, tabnr) end
--- @return string --- @return string
function vim.fn.getline(lnum, end_) end function vim.fn.getline(lnum, end_) end
--- @param lnum integer --- @param lnum integer|string
--- @param end_ true|number|string|table --- @param end_ true|number|string|table
--- @return string|string[] --- @return string|string[]
function vim.fn.getline(lnum, end_) end function vim.fn.getline(lnum, end_) end
@@ -5170,7 +5170,7 @@ function vim.fn.line(expr, winid) end
--- |getline()|. When {lnum} is invalid -1 is returned. --- |getline()|. When {lnum} is invalid -1 is returned.
--- Also see |byte2line()|, |go| and |:goto|. --- Also see |byte2line()|, |go| and |:goto|.
--- ---
--- @param lnum integer --- @param lnum integer|string
--- @return integer --- @return integer
function vim.fn.line2byte(lnum) end function vim.fn.line2byte(lnum) end
@@ -5180,7 +5180,7 @@ function vim.fn.line2byte(lnum) end
--- relevant. {lnum} is used just like in |getline()|. --- relevant. {lnum} is used just like in |getline()|.
--- When {lnum} is invalid, -1 is returned. --- When {lnum} is invalid, -1 is returned.
--- ---
--- @param lnum integer --- @param lnum integer|string
--- @return integer --- @return integer
function vim.fn.lispindent(lnum) end function vim.fn.lispindent(lnum) end
@@ -6352,7 +6352,7 @@ function vim.fn.msgpackparse(data) end
--- {lnum} is used like with |getline()|. --- {lnum} is used like with |getline()|.
--- See also |prevnonblank()|. --- See also |prevnonblank()|.
--- ---
--- @param lnum integer --- @param lnum integer|string
--- @return integer --- @return integer
function vim.fn.nextnonblank(lnum) end function vim.fn.nextnonblank(lnum) end
@@ -6451,7 +6451,7 @@ function vim.fn.pow(x, y) end
--- {lnum} is used like with |getline()|. --- {lnum} is used like with |getline()|.
--- Also see |nextnonblank()|. --- Also see |nextnonblank()|.
--- ---
--- @param lnum integer --- @param lnum integer|string
--- @return integer --- @return integer
function vim.fn.prevnonblank(lnum) end function vim.fn.prevnonblank(lnum) end
@@ -8060,7 +8060,7 @@ function vim.fn.setcmdline(str, pos) end
--- @return any --- @return any
function vim.fn.setcmdpos(pos) end function vim.fn.setcmdpos(pos) end
--- @param lnum integer --- @param lnum integer|string
--- @param col? integer --- @param col? integer
--- @param off? integer --- @param off? integer
--- @return any --- @return any
@@ -8139,7 +8139,7 @@ function vim.fn.setfperm(fname, mode) end
--- ---
--- <Note: The '[ and '] marks are not set. --- <Note: The '[ and '] marks are not set.
--- ---
--- @param lnum integer --- @param lnum integer|string
--- @param text any --- @param text any
--- @return any --- @return any
function vim.fn.setline(lnum, text) end function vim.fn.setline(lnum, text) end
@@ -9895,7 +9895,7 @@ function vim.fn.swapname(buf) end
--- echo synIDattr(synID(line("."), col("."), 1), "name") --- echo synIDattr(synID(line("."), col("."), 1), "name")
--- < --- <
--- ---
--- @param lnum integer --- @param lnum integer|string
--- @param col integer --- @param col integer
--- @param trans 0|1 --- @param trans 0|1
--- @return integer --- @return integer
@@ -9991,7 +9991,7 @@ function vim.fn.synIDtrans(synID) end
--- since syntax and matching highlighting are two different --- since syntax and matching highlighting are two different
--- mechanisms |syntax-vs-match|. --- mechanisms |syntax-vs-match|.
--- ---
--- @param lnum integer --- @param lnum integer|string
--- @param col integer --- @param col integer
--- @return [integer, string, integer] --- @return [integer, string, integer]
function vim.fn.synconcealed(lnum, col) end function vim.fn.synconcealed(lnum, col) end
@@ -10014,7 +10014,7 @@ function vim.fn.synconcealed(lnum, col) end
--- character in a line and the first column in an empty line are --- character in a line and the first column in an empty line are
--- valid positions. --- valid positions.
--- ---
--- @param lnum integer --- @param lnum integer|string
--- @param col integer --- @param col integer
--- @return integer[] --- @return integer[]
function vim.fn.synstack(lnum, col) end function vim.fn.synstack(lnum, col) end

38
src/nvim/eval.lua
View File

@@ -153,7 +153,7 @@ M.funcs = {
]=], ]=],
name = 'append', name = 'append',
params = { { 'lnum', 'integer' }, { 'text', 'string|string[]' } }, params = { { 'lnum', 'integer|string' }, { 'text', 'string|string[]' } },
returns = '0|1', returns = '0|1',
signature = 'append({lnum}, {text})', signature = 'append({lnum}, {text})',
}, },
@@ -1235,7 +1235,7 @@ M.funcs = {
]=], ]=],
name = 'cindent', name = 'cindent',
params = { { 'lnum', 'integer' } }, params = { { 'lnum', 'integer|string' } },
returns = 'integer', returns = 'integer',
signature = 'cindent({lnum})', signature = 'cindent({lnum})',
}, },
@@ -1663,7 +1663,7 @@ M.funcs = {
args = { 1, 3 }, args = { 1, 3 },
base = 1, base = 1,
name = 'cursor', name = 'cursor',
params = { { 'lnum', 'integer' }, { 'col', 'integer' }, { 'off', 'integer' } }, params = { { 'lnum', 'integer|string' }, { 'col', 'integer' }, { 'off', 'integer' } },
signature = 'cursor({lnum}, {col} [, {off}])', signature = 'cursor({lnum}, {col} [, {off}])',
}, },
cursor__1 = { cursor__1 = {
@@ -1898,7 +1898,7 @@ M.funcs = {
]=], ]=],
name = 'diff_filler', name = 'diff_filler',
params = { { 'lnum', 'integer' } }, params = { { 'lnum', 'integer|string' } },
returns = 'integer', returns = 'integer',
signature = 'diff_filler({lnum})', signature = 'diff_filler({lnum})',
}, },
@@ -1918,7 +1918,7 @@ M.funcs = {
]=], ]=],
name = 'diff_hlID', name = 'diff_hlID',
params = { { 'lnum', 'integer' }, { 'col', 'integer' } }, params = { { 'lnum', 'integer|string' }, { 'col', 'integer' } },
signature = 'diff_hlID({lnum}, {col})', signature = 'diff_hlID({lnum}, {col})',
}, },
digraph_get = { digraph_get = {
@@ -2915,7 +2915,7 @@ M.funcs = {
]=], ]=],
name = 'foldclosed', name = 'foldclosed',
params = { { 'lnum', 'integer' } }, params = { { 'lnum', 'integer|string' } },
returns = 'integer', returns = 'integer',
signature = 'foldclosed({lnum})', signature = 'foldclosed({lnum})',
}, },
@@ -2931,7 +2931,7 @@ M.funcs = {
]=], ]=],
name = 'foldclosedend', name = 'foldclosedend',
params = { { 'lnum', 'integer' } }, params = { { 'lnum', 'integer|string' } },
returns = 'integer', returns = 'integer',
signature = 'foldclosedend({lnum})', signature = 'foldclosedend({lnum})',
}, },
@@ -2952,7 +2952,7 @@ M.funcs = {
]=], ]=],
name = 'foldlevel', name = 'foldlevel',
params = { { 'lnum', 'integer' } }, params = { { 'lnum', 'integer|string' } },
returns = 'integer', returns = 'integer',
signature = 'foldlevel({lnum})', signature = 'foldlevel({lnum})',
}, },
@@ -2993,7 +2993,7 @@ M.funcs = {
]=], ]=],
name = 'foldtextresult', name = 'foldtextresult',
params = { { 'lnum', 'integer' } }, params = { { 'lnum', 'integer|string' } },
returns = 'string', returns = 'string',
signature = 'foldtextresult({lnum})', signature = 'foldtextresult({lnum})',
}, },
@@ -4126,7 +4126,7 @@ M.funcs = {
args = { 2 }, args = { 2 },
base = 1, base = 1,
name = 'getline', name = 'getline',
params = { { 'lnum', 'integer' }, { 'end', 'true|number|string|table' } }, params = { { 'lnum', 'integer|string' }, { 'end', 'true|number|string|table' } },
returns = 'string|string[]', returns = 'string|string[]',
}, },
getloclist = { getloclist = {
@@ -6374,7 +6374,7 @@ M.funcs = {
]=], ]=],
name = 'line2byte', name = 'line2byte',
params = { { 'lnum', 'integer' } }, params = { { 'lnum', 'integer|string' } },
returns = 'integer', returns = 'integer',
signature = 'line2byte({lnum})', signature = 'line2byte({lnum})',
}, },
@@ -6390,7 +6390,7 @@ M.funcs = {
]=], ]=],
name = 'lispindent', name = 'lispindent',
params = { { 'lnum', 'integer' } }, params = { { 'lnum', 'integer|string' } },
returns = 'integer', returns = 'integer',
signature = 'lispindent({lnum})', signature = 'lispindent({lnum})',
}, },
@@ -7748,7 +7748,7 @@ M.funcs = {
]=], ]=],
name = 'nextnonblank', name = 'nextnonblank',
params = { { 'lnum', 'integer' } }, params = { { 'lnum', 'integer|string' } },
returns = 'integer', returns = 'integer',
signature = 'nextnonblank({lnum})', signature = 'nextnonblank({lnum})',
}, },
@@ -7896,7 +7896,7 @@ M.funcs = {
]=], ]=],
name = 'prevnonblank', name = 'prevnonblank',
params = { { 'lnum', 'integer' } }, params = { { 'lnum', 'integer|string' } },
returns = 'integer', returns = 'integer',
signature = 'prevnonblank({lnum})', signature = 'prevnonblank({lnum})',
}, },
@@ -9772,7 +9772,7 @@ M.funcs = {
args = { 1, 3 }, args = { 1, 3 },
base = 1, base = 1,
name = 'setcursorcharpos', name = 'setcursorcharpos',
params = { { 'lnum', 'integer' }, { 'col', 'integer' }, { 'off', 'integer' } }, params = { { 'lnum', 'integer|string' }, { 'col', 'integer' }, { 'off', 'integer' } },
signature = 'setcursorcharpos({lnum}, {col} [, {off}])', signature = 'setcursorcharpos({lnum}, {col} [, {off}])',
}, },
setcursorcharpos__1 = { setcursorcharpos__1 = {
@@ -9867,7 +9867,7 @@ M.funcs = {
]=], ]=],
name = 'setline', name = 'setline',
params = { { 'lnum', 'integer' }, { 'text', 'any' } }, params = { { 'lnum', 'integer|string' }, { 'text', 'any' } },
signature = 'setline({lnum}, {text})', signature = 'setline({lnum}, {text})',
}, },
setloclist = { setloclist = {
@@ -11936,7 +11936,7 @@ M.funcs = {
< <
]=], ]=],
name = 'synID', name = 'synID',
params = { { 'lnum', 'integer' }, { 'col', 'integer' }, { 'trans', '0|1' } }, params = { { 'lnum', 'integer|string' }, { 'col', 'integer' }, { 'trans', '0|1' } },
returns = 'integer', returns = 'integer',
signature = 'synID({lnum}, {col}, {trans})', signature = 'synID({lnum}, {col}, {trans})',
}, },
@@ -12043,7 +12043,7 @@ M.funcs = {
mechanisms |syntax-vs-match|. mechanisms |syntax-vs-match|.
]=], ]=],
name = 'synconcealed', name = 'synconcealed',
params = { { 'lnum', 'integer' }, { 'col', 'integer' } }, params = { { 'lnum', 'integer|string' }, { 'col', 'integer' } },
returns = '[integer, string, integer]', returns = '[integer, string, integer]',
signature = 'synconcealed({lnum}, {col})', signature = 'synconcealed({lnum}, {col})',
}, },
@@ -12069,7 +12069,7 @@ M.funcs = {
valid positions. valid positions.
]=], ]=],
name = 'synstack', name = 'synstack',
params = { { 'lnum', 'integer' }, { 'col', 'integer' } }, params = { { 'lnum', 'integer|string' }, { 'col', 'integer' } },
returns = 'integer[]', returns = 'integer[]',
signature = 'synstack({lnum}, {col})', signature = 'synstack({lnum}, {col})',
}, },