diff options
| author | zeertzjq <zeertzjq@outlook.com> | 2024-06-14 04:45:12 +0800 |
|---|---|---|
| committer | zeertzjq <zeertzjq@outlook.com> | 2024-06-14 04:49:21 +0800 |
| commit | 6ba152168787e2cf7d197d8f2d682daaca0c94cf (patch) | |
| tree | f0d62dcc12aec34df5bd42a6e2d939125f851775 /runtime/lua/vim/_meta/vimfn.lua | |
| parent | fab3d4721ffb5109c2c30633605af30d37d7d229 (diff) | |
| download | rneovim-6ba152168787e2cf7d197d8f2d682daaca0c94cf.tar.gz rneovim-6ba152168787e2cf7d197d8f2d682daaca0c94cf.tar.bz2 rneovim-6ba152168787e2cf7d197d8f2d682daaca0c94cf.zip | |
vim-patch:d353d27: runtime(doc): restore description of "$" in col() and virtcol() (vim/vim#14981)
These are different from line() and getpos().
https://github.com/vim/vim/commit/d353d2782032b91498601afefee4256592f48074
Diffstat (limited to 'runtime/lua/vim/_meta/vimfn.lua')
| -rw-r--r-- | runtime/lua/vim/_meta/vimfn.lua | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua index e9794b444c..f868aec423 100644 --- a/runtime/lua/vim/_meta/vimfn.lua +++ b/runtime/lua/vim/_meta/vimfn.lua @@ -913,6 +913,8 @@ function vim.fn.clearmatches(win) end --- The result is a Number, which is the byte index of the column --- position given with {expr}. --- For accepted positions see |getpos()|. +--- When {expr} is "$", it means the end of the cursor line, so +--- the result is the number of bytes in the cursor line plus one. --- Additionally {expr} can be [lnum, col]: a |List| with the line --- and column number. Most useful when the column is "$", to get --- the last column of a specific line. When "lnum" or "col" is @@ -3332,7 +3334,7 @@ function vim.fn.getpid() end --- . The cursor position. --- $ The last line in the current buffer. --- 'x Position of mark x (if the mark is not set, 0 is ---- returned). +--- returned for all values). --- w0 First line visible in current window (one if the --- display isn't updated, e.g. in silent Ex mode). --- w$ Last line visible in current window (this is one @@ -3382,8 +3384,8 @@ function vim.fn.getpid() end --- let save_a_mark = getpos("'a") --- " ... --- call setpos("'a", save_a_mark) ---- ---- <Also see |getcharpos()|, |getcurpos()| and |setpos()|. +--- < +--- Also see |getcharpos()|, |getcurpos()| and |setpos()|. --- --- @param expr string --- @return integer[] @@ -10416,6 +10418,8 @@ function vim.fn.values(dict) end --- For the byte position use |col()|. --- --- For the use of {expr} see |getpos()| and |col()|. +--- When {expr} is "$", it means the end of the cursor line, so +--- the result is the number of cells in the cursor line plus one. --- --- When 'virtualedit' is used {expr} can be [lnum, col, off], --- where "off" is the offset in screen columns from the start of |