aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim/_meta/vimfn.lua
diff options
context:
space:
mode:
authorSean Dewar <6256228+seandewar@users.noreply.github.com>2025-03-31 21:02:04 +0100
committerSean Dewar <6256228+seandewar@users.noreply.github.com>2025-04-01 10:55:39 +0100
commit4a36f234ace7aef8ff626e753eb7bab08754fc17 (patch)
treed837edca2f93df67dbba3027febc497f27bd30ce /runtime/lua/vim/_meta/vimfn.lua
parent2322ae403b24699a432a1744e502310e252cb1d3 (diff)
downloadrneovim-4a36f234ace7aef8ff626e753eb7bab08754fc17.tar.gz
rneovim-4a36f234ace7aef8ff626e753eb7bab08754fc17.tar.bz2
rneovim-4a36f234ace7aef8ff626e753eb7bab08754fc17.zip
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.
Diffstat (limited to 'runtime/lua/vim/_meta/vimfn.lua')
-rw-r--r--runtime/lua/vim/_meta/vimfn.lua38
1 files changed, 19 insertions, 19 deletions
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua
index 813a89898e..2d87d203d9 100644
--- a/runtime/lua/vim/_meta/vimfn.lua
+++ b/runtime/lua/vim/_meta/vimfn.lua
@@ -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
@@ -6355,7 +6355,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
@@ -6454,7 +6454,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
@@ -8063,7 +8063,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
@@ -8142,7 +8142,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
@@ -9898,7 +9898,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
@@ -9994,7 +9994,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
@@ -10017,7 +10017,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