mirror of
https://github.com/neovim/neovim.git
synced 2025-10-01 23:48:32 +00:00
docs(eval): fix lnum type for functions using tv_get_lnum
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
committed by
github-actions[bot]
github-actions[bot]
parent
326eacef93
commit
09fd22d5d7
32
runtime/doc/builtin.txt
generated
32
runtime/doc/builtin.txt
generated
@@ -110,7 +110,7 @@ append({lnum}, {text}) *append()*
|
||||
<
|
||||
|
||||
Parameters: ~
|
||||
• {lnum} (`integer`)
|
||||
• {lnum} (`integer|string`)
|
||||
• {text} (`string|string[]`)
|
||||
|
||||
Return: ~
|
||||
@@ -1047,7 +1047,7 @@ cindent({lnum}) *cindent()*
|
||||
To get or set indent of lines in a string, see |vim.text.indent()|.
|
||||
|
||||
Parameters: ~
|
||||
• {lnum} (`integer`)
|
||||
• {lnum} (`integer|string`)
|
||||
|
||||
Return: ~
|
||||
(`integer`)
|
||||
@@ -1637,7 +1637,7 @@ diff_filler({lnum}) *diff_filler()*
|
||||
Returns 0 if the current window is not in diff mode.
|
||||
|
||||
Parameters: ~
|
||||
• {lnum} (`integer`)
|
||||
• {lnum} (`integer|string`)
|
||||
|
||||
Return: ~
|
||||
(`integer`)
|
||||
@@ -1654,7 +1654,7 @@ diff_hlID({lnum}, {col}) *diff_hlID()*
|
||||
syntax information about the highlighting.
|
||||
|
||||
Parameters: ~
|
||||
• {lnum} (`integer`)
|
||||
• {lnum} (`integer|string`)
|
||||
• {col} (`integer`)
|
||||
|
||||
Return: ~
|
||||
@@ -2563,7 +2563,7 @@ foldclosed({lnum}) *foldclosed()*
|
||||
line, "'m" mark m, etc.
|
||||
|
||||
Parameters: ~
|
||||
• {lnum} (`integer`)
|
||||
• {lnum} (`integer|string`)
|
||||
|
||||
Return: ~
|
||||
(`integer`)
|
||||
@@ -2576,7 +2576,7 @@ foldclosedend({lnum}) *foldclosedend()*
|
||||
line, "'m" mark m, etc.
|
||||
|
||||
Parameters: ~
|
||||
• {lnum} (`integer`)
|
||||
• {lnum} (`integer|string`)
|
||||
|
||||
Return: ~
|
||||
(`integer`)
|
||||
@@ -2594,7 +2594,7 @@ foldlevel({lnum}) *foldlevel()*
|
||||
line, "'m" mark m, etc.
|
||||
|
||||
Parameters: ~
|
||||
• {lnum} (`integer`)
|
||||
• {lnum} (`integer|string`)
|
||||
|
||||
Return: ~
|
||||
(`integer`)
|
||||
@@ -2629,7 +2629,7 @@ foldtextresult({lnum}) *foldtextresult()*
|
||||
Useful when exporting folded text, e.g., to HTML.
|
||||
|
||||
Parameters: ~
|
||||
• {lnum} (`integer`)
|
||||
• {lnum} (`integer|string`)
|
||||
|
||||
Return: ~
|
||||
(`string`)
|
||||
@@ -5706,7 +5706,7 @@ line2byte({lnum}) *line2byte()*
|
||||
Also see |byte2line()|, |go| and |:goto|.
|
||||
|
||||
Parameters: ~
|
||||
• {lnum} (`integer`)
|
||||
• {lnum} (`integer|string`)
|
||||
|
||||
Return: ~
|
||||
(`integer`)
|
||||
@@ -5719,7 +5719,7 @@ lispindent({lnum}) *lispindent()*
|
||||
When {lnum} is invalid, -1 is returned.
|
||||
|
||||
Parameters: ~
|
||||
• {lnum} (`integer`)
|
||||
• {lnum} (`integer|string`)
|
||||
|
||||
Return: ~
|
||||
(`integer`)
|
||||
@@ -6990,7 +6990,7 @@ nextnonblank({lnum}) *nextnonblank()*
|
||||
See also |prevnonblank()|.
|
||||
|
||||
Parameters: ~
|
||||
• {lnum} (`integer`)
|
||||
• {lnum} (`integer|string`)
|
||||
|
||||
Return: ~
|
||||
(`integer`)
|
||||
@@ -7124,7 +7124,7 @@ prevnonblank({lnum}) *prevnonblank()*
|
||||
Also see |nextnonblank()|.
|
||||
|
||||
Parameters: ~
|
||||
• {lnum} (`integer`)
|
||||
• {lnum} (`integer|string`)
|
||||
|
||||
Return: ~
|
||||
(`integer`)
|
||||
@@ -8937,7 +8937,7 @@ setline({lnum}, {text}) *setline()*
|
||||
< Note: The '[ and '] marks are not set.
|
||||
|
||||
Parameters: ~
|
||||
• {lnum} (`integer`)
|
||||
• {lnum} (`integer|string`)
|
||||
• {text} (`any`)
|
||||
|
||||
Return: ~
|
||||
@@ -10851,7 +10851,7 @@ synID({lnum}, {col}, {trans}) *synID()*
|
||||
<
|
||||
|
||||
Parameters: ~
|
||||
• {lnum} (`integer`)
|
||||
• {lnum} (`integer|string`)
|
||||
• {col} (`integer`)
|
||||
• {trans} (`0|1`)
|
||||
|
||||
@@ -10956,7 +10956,7 @@ synconcealed({lnum}, {col}) *synconcealed()*
|
||||
mechanisms |syntax-vs-match|.
|
||||
|
||||
Parameters: ~
|
||||
• {lnum} (`integer`)
|
||||
• {lnum} (`integer|string`)
|
||||
• {col} (`integer`)
|
||||
|
||||
Return: ~
|
||||
@@ -10982,7 +10982,7 @@ synstack({lnum}, {col}) *synstack()*
|
||||
valid positions.
|
||||
|
||||
Parameters: ~
|
||||
• {lnum} (`integer`)
|
||||
• {lnum} (`integer|string`)
|
||||
• {col} (`integer`)
|
||||
|
||||
Return: ~
|
||||
|
||||
@@ -184,14 +184,14 @@
|
||||
--- @field signs vim.fn.sign[]
|
||||
|
||||
--- @class vim.fn.sign_place.dict
|
||||
--- @field lnum? integer
|
||||
--- @field lnum? integer|string
|
||||
--- @field priority? integer
|
||||
|
||||
--- @class vim.fn.sign_placelist.list.item
|
||||
--- @field buffer integer|string
|
||||
--- @field group? string
|
||||
--- @field id? integer
|
||||
--- @field lnum integer
|
||||
--- @field lnum? integer|string
|
||||
--- @field name string
|
||||
--- @field priority? integer
|
||||
|
||||
|
||||
38
runtime/lua/vim/_meta/vimfn.lua
generated
38
runtime/lua/vim/_meta/vimfn.lua
generated
@@ -85,7 +85,7 @@ function vim.fn.api_info() end
|
||||
--- let failed = append(0, ["Chapter 1", "the beginning"])
|
||||
--- <
|
||||
---
|
||||
--- @param lnum integer
|
||||
--- @param lnum integer|string
|
||||
--- @param text string|string[]
|
||||
--- @return 0|1
|
||||
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()|.
|
||||
---
|
||||
--- @param lnum integer
|
||||
--- @param lnum integer|string
|
||||
--- @return integer
|
||||
function vim.fn.cindent(lnum) end
|
||||
|
||||
@@ -1244,7 +1244,7 @@ function vim.fn.ctxset(context, index) end
|
||||
--- @return any
|
||||
function vim.fn.ctxsize() end
|
||||
|
||||
--- @param lnum integer
|
||||
--- @param lnum integer|string
|
||||
--- @param col? integer
|
||||
--- @param off? integer
|
||||
--- @return any
|
||||
@@ -1441,7 +1441,7 @@ function vim.fn.did_filetype() end
|
||||
--- line, "'m" mark m, etc.
|
||||
--- Returns 0 if the current window is not in diff mode.
|
||||
---
|
||||
--- @param lnum integer
|
||||
--- @param lnum integer|string
|
||||
--- @return integer
|
||||
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
|
||||
--- syntax information about the highlighting.
|
||||
---
|
||||
--- @param lnum integer
|
||||
--- @param lnum integer|string
|
||||
--- @param col integer
|
||||
--- @return any
|
||||
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
|
||||
--- line, "'m" mark m, etc.
|
||||
---
|
||||
--- @param lnum integer
|
||||
--- @param lnum integer|string
|
||||
--- @return integer
|
||||
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
|
||||
--- line, "'m" mark m, etc.
|
||||
---
|
||||
--- @param lnum integer
|
||||
--- @param lnum integer|string
|
||||
--- @return integer
|
||||
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
|
||||
--- line, "'m" mark m, etc.
|
||||
---
|
||||
--- @param lnum integer
|
||||
--- @param lnum integer|string
|
||||
--- @return integer
|
||||
function vim.fn.foldlevel(lnum) end
|
||||
|
||||
@@ -2338,7 +2338,7 @@ function vim.fn.foldtext() end
|
||||
--- line, "'m" mark m, etc.
|
||||
--- Useful when exporting folded text, e.g., to HTML.
|
||||
---
|
||||
--- @param lnum integer
|
||||
--- @param lnum integer|string
|
||||
--- @return string
|
||||
function vim.fn.foldtextresult(lnum) end
|
||||
|
||||
@@ -3284,7 +3284,7 @@ function vim.fn.getjumplist(winnr, tabnr) end
|
||||
--- @return string
|
||||
function vim.fn.getline(lnum, end_) end
|
||||
|
||||
--- @param lnum integer
|
||||
--- @param lnum integer|string
|
||||
--- @param end_ true|number|string|table
|
||||
--- @return string|string[]
|
||||
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.
|
||||
--- Also see |byte2line()|, |go| and |:goto|.
|
||||
---
|
||||
--- @param lnum integer
|
||||
--- @param lnum integer|string
|
||||
--- @return integer
|
||||
function vim.fn.line2byte(lnum) end
|
||||
|
||||
@@ -5180,7 +5180,7 @@ function vim.fn.line2byte(lnum) end
|
||||
--- relevant. {lnum} is used just like in |getline()|.
|
||||
--- When {lnum} is invalid, -1 is returned.
|
||||
---
|
||||
--- @param lnum integer
|
||||
--- @param lnum integer|string
|
||||
--- @return integer
|
||||
function vim.fn.lispindent(lnum) end
|
||||
|
||||
@@ -6352,7 +6352,7 @@ function vim.fn.msgpackparse(data) end
|
||||
--- {lnum} is used like with |getline()|.
|
||||
--- See also |prevnonblank()|.
|
||||
---
|
||||
--- @param lnum integer
|
||||
--- @param lnum integer|string
|
||||
--- @return integer
|
||||
function vim.fn.nextnonblank(lnum) end
|
||||
|
||||
@@ -6451,7 +6451,7 @@ function vim.fn.pow(x, y) end
|
||||
--- {lnum} is used like with |getline()|.
|
||||
--- Also see |nextnonblank()|.
|
||||
---
|
||||
--- @param lnum integer
|
||||
--- @param lnum integer|string
|
||||
--- @return integer
|
||||
function vim.fn.prevnonblank(lnum) end
|
||||
|
||||
@@ -8060,7 +8060,7 @@ function vim.fn.setcmdline(str, pos) end
|
||||
--- @return any
|
||||
function vim.fn.setcmdpos(pos) end
|
||||
|
||||
--- @param lnum integer
|
||||
--- @param lnum integer|string
|
||||
--- @param col? integer
|
||||
--- @param off? integer
|
||||
--- @return any
|
||||
@@ -8139,7 +8139,7 @@ function vim.fn.setfperm(fname, mode) end
|
||||
---
|
||||
--- <Note: The '[ and '] marks are not set.
|
||||
---
|
||||
--- @param lnum integer
|
||||
--- @param lnum integer|string
|
||||
--- @param text any
|
||||
--- @return any
|
||||
function vim.fn.setline(lnum, text) end
|
||||
@@ -9895,7 +9895,7 @@ function vim.fn.swapname(buf) end
|
||||
--- echo synIDattr(synID(line("."), col("."), 1), "name")
|
||||
--- <
|
||||
---
|
||||
--- @param lnum integer
|
||||
--- @param lnum integer|string
|
||||
--- @param col integer
|
||||
--- @param trans 0|1
|
||||
--- @return integer
|
||||
@@ -9991,7 +9991,7 @@ function vim.fn.synIDtrans(synID) end
|
||||
--- since syntax and matching highlighting are two different
|
||||
--- mechanisms |syntax-vs-match|.
|
||||
---
|
||||
--- @param lnum integer
|
||||
--- @param lnum integer|string
|
||||
--- @param col integer
|
||||
--- @return [integer, string, integer]
|
||||
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
|
||||
--- valid positions.
|
||||
---
|
||||
--- @param lnum integer
|
||||
--- @param lnum integer|string
|
||||
--- @param col integer
|
||||
--- @return integer[]
|
||||
function vim.fn.synstack(lnum, col) end
|
||||
|
||||
Reference in New Issue
Block a user