mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-10-18 15:51:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

vim-patch:83eb1da: runtime(doc): Normalise formatting of builtin function descriptions (#36172)

Browse Source 
- Column align tags
- Move tags to the same line as the function signature
- Move descriptions to the line below the function signature
- Add missing hyperlinks to builtins in the description text

closes: vim/vim#18478

83eb1da19e

Co-authored-by: Doug Kearns <dougkearns@gmail.com>
This commit is contained in:
zeertzjq
2025-10-14 10:23:26 +08:00
committed by GitHub
parent 72578e5e28
commit fc74b9fb34
3 changed files with 96 additions and 96 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
runtime/doc/vimfn.txt
View File

@@ -72,7 +72,7 @@ add({object}, {expr}) *add()*
and({expr}, {expr}) *and()* and({expr}, {expr}) *and()*
Bitwise AND on the two arguments. The arguments are converted Bitwise AND on the two arguments. The arguments are converted
to a number. A List, Dict or Float argument causes an error. to a number. A List, Dict or Float argument causes an error.
Also see `or()` and `xor()`. Also see |or()| and |xor()|.
Example: >vim Example: >vim
let flag = and(bits, 0x80) let flag = and(bits, 0x80)
< <
@@ -163,7 +163,7 @@ argc([{winid}]) *argc()*
argidx() *argidx()* argidx() *argidx()*
The result is the current index in the argument list. 0 is The result is the current index in the argument list. 0 is
the first file. argc() - 1 is the last one. See |arglist|. the first file. |argc()| - 1 is the last one. See |arglist|.
Return: ~ Return: ~
(`integer`) (`integer`)
@@ -700,7 +700,7 @@ bufnr([{buf} [, {create}]]) *bufnr()*
< The result is a Number, which is the highest buffer number < The result is a Number, which is the highest buffer number
of existing buffers. Note that not all buffers with a smaller of existing buffers. Note that not all buffers with a smaller
number necessarily exist, because ":bwipeout" may have removed number necessarily exist, because ":bwipeout" may have removed
them. Use bufexists() to test for the existence of a buffer. them. Use |bufexists()| to test for the existence of a buffer.
Parameters: ~ Parameters: ~
• {buf} (`integer|string?`) • {buf} (`integer|string?`)
@@ -804,7 +804,7 @@ byteidx({expr}, {nr} [, {utf16}]) *byteidx()*
(`integer`) (`integer`)
byteidxcomp({expr}, {nr} [, {utf16}]) *byteidxcomp()* byteidxcomp({expr}, {nr} [, {utf16}]) *byteidxcomp()*
Like byteidx(), except that a composing character is counted Like |byteidx()|, except that a composing character is counted
as a separate character. Example: >vim as a separate character. Example: >vim
let s = 'e' .. nr2char(0x301) let s = 'e' .. nr2char(0x301)
echo byteidx(s, 1) echo byteidx(s, 1)
@@ -3201,9 +3201,9 @@ getchar([{expr} [, {opts}]]) *getchar()*
When {expr} is 1 only the first byte is returned. For a When {expr} is 1 only the first byte is returned. For a
one-byte character it is the character itself as a number. one-byte character it is the character itself as a number.
Use nr2char() to convert it to a String. Use |nr2char()| to convert it to a String.
Use getcharmod() to obtain any additional modifiers. Use |getcharmod()| to obtain any additional modifiers.
The optional argument {opts} is a Dict and supports the The optional argument {opts} is a Dict and supports the
following items: following items:
@@ -3276,7 +3276,7 @@ getchar([{expr} [, {opts}]]) *getchar()*
getcharmod() *getcharmod()* getcharmod() *getcharmod()*
The result is a Number which is the state of the modifiers for The result is a Number which is the state of the modifiers for
the last obtained character with getchar() or in another way. the last obtained character with |getchar()| or in another way.
These values are added together: These values are added together:
2 shift 2 shift
4 control 4 control
@@ -3686,7 +3686,7 @@ getfsize({fname}) *getfsize()*
getftime({fname}) *getftime()* getftime({fname}) *getftime()*
The result is a Number, which is the last modification time of The result is a Number, which is the last modification time of
the given file {fname}. The value is measured as seconds the given file {fname}. The value is measured as seconds
since 1st Jan 1970, and may be passed to strftime(). See also since 1st Jan 1970, and may be passed to |strftime()|. See also
|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.
@@ -3993,7 +3993,7 @@ getqflist([{what}]) *getqflist()*
Returns a |List| with all the current quickfix errors. Each Returns a |List| with all the current quickfix errors. Each
list item is a dictionary with these entries: list item is a dictionary with these entries:
bufnr number of buffer that has the file name, use bufnr number of buffer that has the file name, use
bufname() to get the name |bufname()| to get the name
module module name module module name
lnum line number in the buffer (first line is 1) lnum line number in the buffer (first line is 1)
end_lnum end_lnum
@@ -4612,7 +4612,7 @@ glob({expr} [, {nosuf} [, {list} [, {alllinks}]]]) *glob()*
(`any`) (`any`)
glob2regpat({string}) *glob2regpat()* glob2regpat({string}) *glob2regpat()*
Convert a file pattern, as used by glob(), into a search Convert a file pattern, as used by |glob()|, into a search
pattern. The result can be used to match with a string that pattern. The result can be used to match with a string that
is a file name. E.g. >vim is a file name. E.g. >vim
if filename =~ glob2regpat('Make*.mak') if filename =~ glob2regpat('Make*.mak')
@@ -4634,7 +4634,7 @@ glob2regpat({string}) *glob2regpat()*
(`string`) (`string`)
globpath({path}, {expr} [, {nosuf} [, {list} [, {allinks}]]]) *globpath()* globpath({path}, {expr} [, {nosuf} [, {list} [, {allinks}]]]) *globpath()*
Perform glob() for String {expr} on all directories in {path} Perform |glob()| for String {expr} on all directories in {path}
and concatenate the results. Example: >vim and concatenate the results. Example: >vim
echo globpath(&rtp, "syntax/c.vim") echo globpath(&rtp, "syntax/c.vim")
< <
@@ -5266,7 +5266,7 @@ inputlist({textlist}) *inputlist()*
inputrestore() *inputrestore()* inputrestore() *inputrestore()*
Restore typeahead that was saved with a previous |inputsave()|. Restore typeahead that was saved with a previous |inputsave()|.
Should be called the same number of times inputsave() is Should be called the same number of times |inputsave()| is
called. Calling it more often is harmless though. called. Calling it more often is harmless though.
Returns TRUE when there is nothing to restore, FALSE Returns TRUE when there is nothing to restore, FALSE
otherwise. otherwise.
@@ -5277,9 +5277,9 @@ inputrestore() *inputrestore()*
inputsave() *inputsave()* inputsave() *inputsave()*
Preserve typeahead (also from mappings) and clear it, so that Preserve typeahead (also from mappings) and clear it, so that
a following prompt gets input from the user. Should be a following prompt gets input from the user. Should be
followed by a matching inputrestore() after the prompt. Can followed by a matching |inputrestore()| after the prompt. Can
be used several times, in which case there must be just as be used several times, in which case there must be just as
many inputrestore() calls. many |inputrestore()| calls.
Returns TRUE when out of memory, FALSE otherwise. Returns TRUE when out of memory, FALSE otherwise.
Return: ~ Return: ~
@@ -5734,7 +5734,7 @@ libcall({libname}, {funcname}, {argument}) *libcall()* *E364* *E
The result is the String returned by the function. If the The result is the String returned by the function. If the
function returns NULL, this will appear as an empty string "" function returns NULL, this will appear as an empty string ""
to Vim. to Vim.
If the function returns a number, use libcallnr()! If the function returns a number, use |libcallnr()|!
If {argument} is a number, it is passed to the function as an If {argument} is a number, it is passed to the function as an
int; if {argument} is a string, it is passed as a int; if {argument} is a string, it is passed as a
null-terminated string. null-terminated string.
@@ -6101,8 +6101,8 @@ mapcheck({name} [, {mode} [, {abbr}]]) *mapcheck()*
mapcheck("ax") yes no no mapcheck("ax") yes no no
mapcheck("b") no no no mapcheck("b") no no no
The difference with maparg() is that mapcheck() finds a The difference with |maparg()| is that mapcheck() finds a
mapping that matches with {name}, while maparg() only finds a mapping that matches with {name}, while |maparg()| only finds a
mapping for {name} exactly. mapping for {name} exactly.
When there is no mapping that starts with {name}, an empty When there is no mapping that starts with {name}, an empty
String is returned. If there is one, the RHS of that mapping String is returned. If there is one, the RHS of that mapping
@@ -6629,7 +6629,7 @@ matchfuzzypos({list}, {str} [, {dict}]) *matchfuzzypos()*
matchlist({expr}, {pat} [, {start} [, {count}]]) *matchlist()* matchlist({expr}, {pat} [, {start} [, {count}]]) *matchlist()*
Same as |match()|, but return a |List|. The first item in the Same as |match()|, but return a |List|. The first item in the
list is the matched string, same as what matchstr() would list is the matched string, same as what |matchstr()| would
return. Following items are submatches, like "\1", "\2", etc. return. Following items are submatches, like "\1", "\2", etc.
in |:substitute|. When an optional submatch didn't match an in |:substitute|. When an optional submatch didn't match an
empty string is used. Example: >vim empty string is used. Example: >vim
@@ -8006,7 +8006,7 @@ reltimefloat({time}) *reltimefloat()*
let start = reltime() let start = reltime()
call MyFunction() call MyFunction()
let seconds = reltimefloat(reltime(start)) let seconds = reltimefloat(reltime(start))
See the note of reltimestr() about overhead. See the note of |reltimestr()| about overhead.
Also see |profiling|. Also see |profiling|.
If there is an error an empty string is returned If there is an error an empty string is returned
@@ -8025,7 +8025,7 @@ reltimestr({time}) *reltimestr()*
echo reltimestr(reltime(start)) echo reltimestr(reltime(start))
< Note that overhead for the commands will be added to the time. < Note that overhead for the commands will be added to the time.
Leading spaces are used to make the string align nicely. You Leading spaces are used to make the string align nicely. You
can use split() to remove it. >vim can use |split()| to remove it. >vim
echo split(reltimestr(reltime(start)))[0] echo split(reltimestr(reltime(start)))[0]
< Also see |profiling|. < Also see |profiling|.
If there is an error an empty string is returned If there is an error an empty string is returned
@@ -10120,7 +10120,7 @@ sort({list} [, {how} [, {dict}]]) *sort()* *E70
When {how} is given and it is 'l' then the current collation When {how} is given and it is 'l' then the current collation
locale is used for ordering. Implementation details: locale is used for ordering. Implementation details:
strcoll() is used to compare strings. See |:language| check strcoll() is used to compare strings. See |:language| to check
or set the collation locale. |v:collate| can also be used to or set the collation locale. |v:collate| can also be used to
check the current locale. Sorting using the locale typically check the current locale. Sorting using the locale typically
ignores case. Example: >vim ignores case. Example: >vim
@@ -10350,7 +10350,7 @@ state([{what}]) *state()*
< <
These characters indicate the state, generally indicating that These characters indicate the state, generally indicating that
something is busy: something is busy:
m halfway a mapping, :normal command, feedkeys() or m halfway a mapping, :normal command, |feedkeys()| or
stuffed command stuffed command
o operator pending, e.g. after |d| o operator pending, e.g. after |d|
a Insert mode autocomplete active a Insert mode autocomplete active
@@ -10859,7 +10859,7 @@ strwidth({string}) *strwidth()*
submatch({nr} [, {list}]) *submatch()* *E935* submatch({nr} [, {list}]) *submatch()* *E935*
Only for an expression in a |:substitute| command or Only for an expression in a |:substitute| command or
substitute() function. |substitute()| function.
Returns the {nr}th submatch of the matched text. When {nr} Returns the {nr}th submatch of the matched text. When {nr}
is 0 the whole matched text is returned. is 0 the whole matched text is returned.
Note that a NL in the string can stand for a line break of a Note that a NL in the string can stand for a line break of a
@@ -10874,7 +10874,7 @@ submatch({nr} [, {list}]) *submatch()* *E93
|substitute()| this list will always contain one or zero |substitute()| this list will always contain one or zero
items, since there are no real line breaks. items, since there are no real line breaks.
When substitute() is used recursively only the submatches in When |substitute()| is used recursively only the submatches in
the current (deepest) call can be obtained. the current (deepest) call can be obtained.
Returns an empty string or list on error. Returns an empty string or list on error.
@@ -11038,7 +11038,7 @@ synIDattr({synID}, {what} [, {mode}]) *synIDattr()*
for that mode. When {mode} is omitted, or an invalid value is for that mode. When {mode} is omitted, or an invalid value is
used, the attributes for the currently active highlighting are used, the attributes for the currently active highlighting are
used (GUI or cterm). used (GUI or cterm).
Use synIDtrans() to follow linked highlight groups. Use |synIDtrans()| to follow linked highlight groups.
{what} result {what} result
"name" the name of the syntax item "name" the name of the syntax item
"fg" foreground color (GUI: color name used to set "fg" foreground color (GUI: color name used to set
@@ -11489,7 +11489,7 @@ timer_start({time}, {callback} [, {options}]) *timer_start()* *time
timer_stop({timer}) *timer_stop()* timer_stop({timer}) *timer_stop()*
Stop a timer. The timer callback will no longer be invoked. Stop a timer. The timer callback will no longer be invoked.
{timer} is an ID returned by timer_start(), thus it must be a {timer} is an ID returned by |timer_start()|, thus it must be a
Number. If {timer} does not exist there is no error. Number. If {timer} does not exist there is no error.
Parameters: ~ Parameters: ~
@@ -11741,7 +11741,7 @@ utf16idx({string}, {idx} [, {countcc} [, {charidx}]]) *utf16idx()*
Returns -1 if the arguments are invalid or if there are less Returns -1 if the arguments are invalid or if there are less
than {idx} bytes in {string}. If there are exactly {idx} than {idx} bytes in {string}. If there are exactly {idx}
bytes the length of the string in UTF-16 code units is bytes, the length of the string in UTF-16 code units is
returned. returned.
See |byteidx()| and |byteidxcomp()| for getting the byte index See |byteidx()| and |byteidxcomp()| for getting the byte index

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

@@ -52,7 +52,7 @@ function vim.fn.add(object, expr) end
--- Bitwise AND on the two arguments. The arguments are converted --- Bitwise AND on the two arguments. The arguments are converted
--- to a number. A List, Dict or Float argument causes an error. --- to a number. A List, Dict or Float argument causes an error.
--- Also see `or()` and `xor()`. --- Also see |or()| and |xor()|.
--- Example: >vim --- Example: >vim
--- let flag = and(bits, 0x80) --- let flag = and(bits, 0x80)
--- < --- <
@@ -130,7 +130,7 @@ function vim.fn.appendbufline(buf, lnum, text) end
function vim.fn.argc(winid) end function vim.fn.argc(winid) end
--- The result is the current index in the argument list. 0 is --- The result is the current index in the argument list. 0 is
--- the first file. argc() - 1 is the last one. See |arglist|. --- the first file. |argc()| - 1 is the last one. See |arglist|.
--- ---
--- @return integer --- @return integer
function vim.fn.argidx() end function vim.fn.argidx() end
@@ -607,7 +607,7 @@ function vim.fn.bufname(buf) end
--- <The result is a Number, which is the highest buffer number --- <The result is a Number, which is the highest buffer number
--- of existing buffers. Note that not all buffers with a smaller --- of existing buffers. Note that not all buffers with a smaller
--- number necessarily exist, because ":bwipeout" may have removed --- number necessarily exist, because ":bwipeout" may have removed
--- them. Use bufexists() to test for the existence of a buffer. --- them. Use |bufexists()| to test for the existence of a buffer.
--- ---
--- @param buf? integer|string --- @param buf? integer|string
--- @param create? any --- @param create? any
@@ -696,7 +696,7 @@ function vim.fn.byte2line(byte) end
--- @return integer --- @return integer
function vim.fn.byteidx(expr, nr, utf16) end function vim.fn.byteidx(expr, nr, utf16) end
--- Like byteidx(), except that a composing character is counted --- Like |byteidx()|, except that a composing character is counted
--- as a separate character. Example: >vim --- as a separate character. Example: >vim
--- let s = 'e' .. nr2char(0x301) --- let s = 'e' .. nr2char(0x301)
--- echo byteidx(s, 1) --- echo byteidx(s, 1)
@@ -2864,9 +2864,9 @@ function vim.fn.getchangelist(buf) end
--- ---
--- When {expr} is 1 only the first byte is returned. For a --- When {expr} is 1 only the first byte is returned. For a
--- one-byte character it is the character itself as a number. --- one-byte character it is the character itself as a number.
--- Use nr2char() to convert it to a String. --- Use |nr2char()| to convert it to a String.
--- ---
--- Use getcharmod() to obtain any additional modifiers. --- Use |getcharmod()| to obtain any additional modifiers.
--- ---
--- The optional argument {opts} is a Dict and supports the --- The optional argument {opts} is a Dict and supports the
--- following items: --- following items:
@@ -2936,7 +2936,7 @@ function vim.fn.getchangelist(buf) end
function vim.fn.getchar(expr, opts) end function vim.fn.getchar(expr, opts) end
--- The result is a Number which is the state of the modifiers for --- The result is a Number which is the state of the modifiers for
--- the last obtained character with getchar() or in another way. --- the last obtained character with |getchar()| or in another way.
--- These values are added together: --- These values are added together:
--- 2 shift --- 2 shift
--- 4 control --- 4 control
@@ -3303,7 +3303,7 @@ function vim.fn.getfsize(fname) end
--- The result is a Number, which is the last modification time of --- The result is a Number, which is the last modification time of
--- the given file {fname}. The value is measured as seconds --- the given file {fname}. The value is measured as seconds
--- since 1st Jan 1970, and may be passed to strftime(). See also --- since 1st Jan 1970, and may be passed to |strftime()|. See also
--- |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.
--- ---
@@ -3589,7 +3589,7 @@ function vim.fn.getpos(expr) end
--- Returns a |List| with all the current quickfix errors. Each --- Returns a |List| with all the current quickfix errors. Each
--- list item is a dictionary with these entries: --- list item is a dictionary with these entries:
--- bufnr number of buffer that has the file name, use --- bufnr number of buffer that has the file name, use
--- bufname() to get the name --- |bufname()| to get the name
--- module module name --- module module name
--- lnum line number in the buffer (first line is 1) --- lnum line number in the buffer (first line is 1)
--- end_lnum --- end_lnum
@@ -4162,7 +4162,7 @@ function vim.fn.getwinvar(winnr, varname, def) end
--- @return any --- @return any
function vim.fn.glob(expr, nosuf, list, alllinks) end function vim.fn.glob(expr, nosuf, list, alllinks) end
--- Convert a file pattern, as used by glob(), into a search --- Convert a file pattern, as used by |glob()|, into a search
--- pattern. The result can be used to match with a string that --- pattern. The result can be used to match with a string that
--- is a file name. E.g. >vim --- is a file name. E.g. >vim
--- if filename =~ glob2regpat('Make*.mak') --- if filename =~ glob2regpat('Make*.mak')
@@ -4181,7 +4181,7 @@ function vim.fn.glob(expr, nosuf, list, alllinks) end
--- @return string --- @return string
function vim.fn.glob2regpat(string) end function vim.fn.glob2regpat(string) end
--- Perform glob() for String {expr} on all directories in {path} --- Perform |glob()| for String {expr} on all directories in {path}
--- and concatenate the results. Example: >vim --- and concatenate the results. Example: >vim
--- echo globpath(&rtp, "syntax/c.vim") --- echo globpath(&rtp, "syntax/c.vim")
--- < --- <
@@ -4776,7 +4776,7 @@ function vim.fn.inputdialog(...) end
function vim.fn.inputlist(textlist) end function vim.fn.inputlist(textlist) end
--- Restore typeahead that was saved with a previous |inputsave()|. --- Restore typeahead that was saved with a previous |inputsave()|.
--- Should be called the same number of times inputsave() is --- Should be called the same number of times |inputsave()| is
--- called. Calling it more often is harmless though. --- called. Calling it more often is harmless though.
--- Returns TRUE when there is nothing to restore, FALSE --- Returns TRUE when there is nothing to restore, FALSE
--- otherwise. --- otherwise.
@@ -4786,9 +4786,9 @@ function vim.fn.inputrestore() end
--- Preserve typeahead (also from mappings) and clear it, so that --- Preserve typeahead (also from mappings) and clear it, so that
--- a following prompt gets input from the user. Should be --- a following prompt gets input from the user. Should be
--- followed by a matching inputrestore() after the prompt. Can --- followed by a matching |inputrestore()| after the prompt. Can
--- be used several times, in which case there must be just as --- be used several times, in which case there must be just as
--- many inputrestore() calls. --- many |inputrestore()| calls.
--- Returns TRUE when out of memory, FALSE otherwise. --- Returns TRUE when out of memory, FALSE otherwise.
--- ---
--- @return integer --- @return integer
@@ -5201,7 +5201,7 @@ function vim.fn.len(expr) end
--- The result is the String returned by the function. If the --- The result is the String returned by the function. If the
--- function returns NULL, this will appear as an empty string "" --- function returns NULL, this will appear as an empty string ""
--- to Vim. --- to Vim.
--- If the function returns a number, use libcallnr()! --- If the function returns a number, use |libcallnr()|!
--- If {argument} is a number, it is passed to the function as an --- If {argument} is a number, it is passed to the function as an
--- int; if {argument} is a string, it is passed as a --- int; if {argument} is a string, it is passed as a
--- null-terminated string. --- null-terminated string.
@@ -5528,8 +5528,8 @@ function vim.fn.maparg(name, mode, abbr, dict) end
--- mapcheck("ax") yes no no --- mapcheck("ax") yes no no
--- mapcheck("b") no no no --- mapcheck("b") no no no
--- ---
--- The difference with maparg() is that mapcheck() finds a --- The difference with |maparg()| is that mapcheck() finds a
--- mapping that matches with {name}, while maparg() only finds a --- mapping that matches with {name}, while |maparg()| only finds a
--- mapping for {name} exactly. --- mapping for {name} exactly.
--- When there is no mapping that starts with {name}, an empty --- When there is no mapping that starts with {name}, an empty
--- String is returned. If there is one, the RHS of that mapping --- String is returned. If there is one, the RHS of that mapping
@@ -6021,7 +6021,7 @@ function vim.fn.matchfuzzy(list, str, dict) end
function vim.fn.matchfuzzypos(list, str, dict) end function vim.fn.matchfuzzypos(list, str, dict) end
--- Same as |match()|, but return a |List|. The first item in the --- Same as |match()|, but return a |List|. The first item in the
--- list is the matched string, same as what matchstr() would --- list is the matched string, same as what |matchstr()| would
--- return. Following items are submatches, like "\1", "\2", etc. --- return. Following items are submatches, like "\1", "\2", etc.
--- in |:substitute|. When an optional submatch didn't match an --- in |:substitute|. When an optional submatch didn't match an
--- empty string is used. Example: >vim --- empty string is used. Example: >vim
@@ -7276,7 +7276,7 @@ function vim.fn.reltime(start, end_) end
--- let start = reltime() --- let start = reltime()
--- call MyFunction() --- call MyFunction()
--- let seconds = reltimefloat(reltime(start)) --- let seconds = reltimefloat(reltime(start))
--- See the note of reltimestr() about overhead. --- See the note of |reltimestr()| about overhead.
--- Also see |profiling|. --- Also see |profiling|.
--- If there is an error an empty string is returned --- If there is an error an empty string is returned
--- ---
@@ -7292,7 +7292,7 @@ function vim.fn.reltimefloat(time) end
--- echo reltimestr(reltime(start)) --- echo reltimestr(reltime(start))
--- <Note that overhead for the commands will be added to the time. --- <Note that overhead for the commands will be added to the time.
--- Leading spaces are used to make the string align nicely. You --- Leading spaces are used to make the string align nicely. You
--- can use split() to remove it. >vim --- can use |split()| to remove it. >vim
--- echo split(reltimestr(reltime(start)))[0] --- echo split(reltimestr(reltime(start)))[0]
--- <Also see |profiling|. --- <Also see |profiling|.
--- If there is an error an empty string is returned --- If there is an error an empty string is returned
@@ -9236,7 +9236,7 @@ function vim.fn.sockconnect(mode, address, opts) end
--- ---
--- When {how} is given and it is 'l' then the current collation --- When {how} is given and it is 'l' then the current collation
--- locale is used for ordering. Implementation details: --- locale is used for ordering. Implementation details:
--- strcoll() is used to compare strings. See |:language| check --- strcoll() is used to compare strings. See |:language| to check
--- or set the collation locale. |v:collate| can also be used to --- or set the collation locale. |v:collate| can also be used to
--- check the current locale. Sorting using the locale typically --- check the current locale. Sorting using the locale typically
--- ignores case. Example: >vim --- ignores case. Example: >vim
@@ -9446,7 +9446,7 @@ function vim.fn.srand(expr) end
--- < --- <
--- These characters indicate the state, generally indicating that --- These characters indicate the state, generally indicating that
--- something is busy: --- something is busy:
--- m halfway a mapping, :normal command, feedkeys() or --- m halfway a mapping, :normal command, |feedkeys()| or
--- stuffed command --- stuffed command
--- o operator pending, e.g. after |d| --- o operator pending, e.g. after |d|
--- a Insert mode autocomplete active --- a Insert mode autocomplete active
@@ -9899,7 +9899,7 @@ function vim.fn.strutf16len(string, countcc) end
function vim.fn.strwidth(string) end function vim.fn.strwidth(string) end
--- Only for an expression in a |:substitute| command or --- Only for an expression in a |:substitute| command or
--- substitute() function. --- |substitute()| function.
--- Returns the {nr}th submatch of the matched text. When {nr} --- Returns the {nr}th submatch of the matched text. When {nr}
--- is 0 the whole matched text is returned. --- is 0 the whole matched text is returned.
--- Note that a NL in the string can stand for a line break of a --- Note that a NL in the string can stand for a line break of a
@@ -9914,7 +9914,7 @@ function vim.fn.strwidth(string) end
--- |substitute()| this list will always contain one or zero --- |substitute()| this list will always contain one or zero
--- items, since there are no real line breaks. --- items, since there are no real line breaks.
--- ---
--- When substitute() is used recursively only the submatches in --- When |substitute()| is used recursively only the submatches in
--- the current (deepest) call can be obtained. --- the current (deepest) call can be obtained.
--- ---
--- Returns an empty string or list on error. --- Returns an empty string or list on error.
@@ -10067,7 +10067,7 @@ function vim.fn.synID(lnum, col, trans) end
--- for that mode. When {mode} is omitted, or an invalid value is --- for that mode. When {mode} is omitted, or an invalid value is
--- used, the attributes for the currently active highlighting are --- used, the attributes for the currently active highlighting are
--- used (GUI or cterm). --- used (GUI or cterm).
--- Use synIDtrans() to follow linked highlight groups. --- Use |synIDtrans()| to follow linked highlight groups.
--- {what} result --- {what} result
--- "name" the name of the syntax item --- "name" the name of the syntax item
--- "fg" foreground color (GUI: color name used to set --- "fg" foreground color (GUI: color name used to set
@@ -10470,7 +10470,7 @@ function vim.fn.timer_pause(timer, paused) end
function vim.fn.timer_start(time, callback, options) end function vim.fn.timer_start(time, callback, options) end
--- Stop a timer. The timer callback will no longer be invoked. --- Stop a timer. The timer callback will no longer be invoked.
--- {timer} is an ID returned by timer_start(), thus it must be a --- {timer} is an ID returned by |timer_start()|, thus it must be a
--- Number. If {timer} does not exist there is no error. --- Number. If {timer} does not exist there is no error.
--- ---
--- @param timer integer --- @param timer integer
@@ -10691,7 +10691,7 @@ function vim.fn.uniq(list, func, dict) end
--- ---
--- Returns -1 if the arguments are invalid or if there are less --- Returns -1 if the arguments are invalid or if there are less
--- than {idx} bytes in {string}. If there are exactly {idx} --- than {idx} bytes in {string}. If there are exactly {idx}
--- bytes the length of the string in UTF-16 code units is --- bytes, the length of the string in UTF-16 code units is
--- returned. --- returned.
--- ---
--- See |byteidx()| and |byteidxcomp()| for getting the byte index --- See |byteidx()| and |byteidxcomp()| for getting the byte index

54
src/nvim/eval.lua
View File

@@ -109,7 +109,7 @@ M.funcs = {
desc = [=[ desc = [=[
Bitwise AND on the two arguments. The arguments are converted Bitwise AND on the two arguments. The arguments are converted
to a number. A List, Dict or Float argument causes an error. to a number. A List, Dict or Float argument causes an error.
Also see `or()` and `xor()`. Also see |or()| and |xor()|.
Example: >vim Example: >vim
let flag = and(bits, 0x80) let flag = and(bits, 0x80)
< <
@@ -207,7 +207,7 @@ M.funcs = {
argidx = { argidx = {
desc = [=[ desc = [=[
The result is the current index in the argument list. 0 is The result is the current index in the argument list. 0 is
the first file. argc() - 1 is the last one. See |arglist|. the first file. |argc()| - 1 is the last one. See |arglist|.
]=], ]=],
name = 'argidx', name = 'argidx',
params = {}, params = {},
@@ -850,7 +850,7 @@ M.funcs = {
<The result is a Number, which is the highest buffer number <The result is a Number, which is the highest buffer number
of existing buffers. Note that not all buffers with a smaller of existing buffers. Note that not all buffers with a smaller
number necessarily exist, because ":bwipeout" may have removed number necessarily exist, because ":bwipeout" may have removed
them. Use bufexists() to test for the existence of a buffer. them. Use |bufexists()| to test for the existence of a buffer.
]=], ]=],
name = 'bufnr', name = 'bufnr',
@@ -966,7 +966,7 @@ M.funcs = {
args = { 2, 3 }, args = { 2, 3 },
base = 1, base = 1,
desc = [=[ desc = [=[
Like byteidx(), except that a composing character is counted Like |byteidx()|, except that a composing character is counted
as a separate character. Example: >vim as a separate character. Example: >vim
let s = 'e' .. nr2char(0x301) let s = 'e' .. nr2char(0x301)
echo byteidx(s, 1) echo byteidx(s, 1)
@@ -3599,9 +3599,9 @@ M.funcs = {
When {expr} is 1 only the first byte is returned. For a When {expr} is 1 only the first byte is returned. For a
one-byte character it is the character itself as a number. one-byte character it is the character itself as a number.
Use nr2char() to convert it to a String. Use |nr2char()| to convert it to a String.
Use getcharmod() to obtain any additional modifiers. Use |getcharmod()| to obtain any additional modifiers.
The optional argument {opts} is a Dict and supports the The optional argument {opts} is a Dict and supports the
following items: following items:
@@ -3673,7 +3673,7 @@ M.funcs = {
getcharmod = { getcharmod = {
desc = [=[ desc = [=[
The result is a Number which is the state of the modifiers for The result is a Number which is the state of the modifiers for
the last obtained character with getchar() or in another way. the last obtained character with |getchar()| or in another way.
These values are added together: These values are added together:
2 shift 2 shift
4 control 4 control
@@ -4137,7 +4137,7 @@ M.funcs = {
desc = [=[ desc = [=[
The result is a Number, which is the last modification time of The result is a Number, which is the last modification time of
the given file {fname}. The value is measured as seconds the given file {fname}. The value is measured as seconds
since 1st Jan 1970, and may be passed to strftime(). See also since 1st Jan 1970, and may be passed to |strftime()|. See also
|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.
@@ -4474,7 +4474,7 @@ M.funcs = {
Returns a |List| with all the current quickfix errors. Each Returns a |List| with all the current quickfix errors. Each
list item is a dictionary with these entries: list item is a dictionary with these entries:
bufnr number of buffer that has the file name, use bufnr number of buffer that has the file name, use
bufname() to get the name |bufname()| to get the name
module module name module module name
lnum line number in the buffer (first line is 1) lnum line number in the buffer (first line is 1)
end_lnum end_lnum
@@ -5142,7 +5142,7 @@ M.funcs = {
args = 1, args = 1,
base = 1, base = 1,
desc = [=[ desc = [=[
Convert a file pattern, as used by glob(), into a search Convert a file pattern, as used by |glob()|, into a search
pattern. The result can be used to match with a string that pattern. The result can be used to match with a string that
is a file name. E.g. >vim is a file name. E.g. >vim
if filename =~ glob2regpat('Make*.mak') if filename =~ glob2regpat('Make*.mak')
@@ -5167,7 +5167,7 @@ M.funcs = {
args = { 2, 5 }, args = { 2, 5 },
base = 2, base = 2,
desc = [=[ desc = [=[
Perform glob() for String {expr} on all directories in {path} Perform |glob()| for String {expr} on all directories in {path}
and concatenate the results. Example: >vim and concatenate the results. Example: >vim
echo globpath(&rtp, "syntax/c.vim") echo globpath(&rtp, "syntax/c.vim")
< <
@@ -5866,7 +5866,7 @@ M.funcs = {
inputrestore = { inputrestore = {
desc = [=[ desc = [=[
Restore typeahead that was saved with a previous |inputsave()|. Restore typeahead that was saved with a previous |inputsave()|.
Should be called the same number of times inputsave() is Should be called the same number of times |inputsave()| is
called. Calling it more often is harmless though. called. Calling it more often is harmless though.
Returns TRUE when there is nothing to restore, FALSE Returns TRUE when there is nothing to restore, FALSE
otherwise. otherwise.
@@ -5880,9 +5880,9 @@ M.funcs = {
desc = [=[ desc = [=[
Preserve typeahead (also from mappings) and clear it, so that Preserve typeahead (also from mappings) and clear it, so that
a following prompt gets input from the user. Should be a following prompt gets input from the user. Should be
followed by a matching inputrestore() after the prompt. Can followed by a matching |inputrestore()| after the prompt. Can
be used several times, in which case there must be just as be used several times, in which case there must be just as
many inputrestore() calls. many |inputrestore()| calls.
Returns TRUE when out of memory, FALSE otherwise. Returns TRUE when out of memory, FALSE otherwise.
]=], ]=],
name = 'inputsave', name = 'inputsave',
@@ -6412,7 +6412,7 @@ M.funcs = {
The result is the String returned by the function. If the The result is the String returned by the function. If the
function returns NULL, this will appear as an empty string "" function returns NULL, this will appear as an empty string ""
to Vim. to Vim.
If the function returns a number, use libcallnr()! If the function returns a number, use |libcallnr()|!
If {argument} is a number, it is passed to the function as an If {argument} is a number, it is passed to the function as an
int; if {argument} is a string, it is passed as a int; if {argument} is a string, it is passed as a
null-terminated string. null-terminated string.
@@ -6822,8 +6822,8 @@ M.funcs = {
mapcheck("ax") yes no no mapcheck("ax") yes no no
mapcheck("b") no no no mapcheck("b") no no no
The difference with maparg() is that mapcheck() finds a The difference with |maparg()| is that mapcheck() finds a
mapping that matches with {name}, while maparg() only finds a mapping that matches with {name}, while |maparg()| only finds a
mapping for {name} exactly. mapping for {name} exactly.
When there is no mapping that starts with {name}, an empty When there is no mapping that starts with {name}, an empty
String is returned. If there is one, the RHS of that mapping String is returned. If there is one, the RHS of that mapping
@@ -7387,7 +7387,7 @@ M.funcs = {
base = 1, base = 1,
desc = [=[ desc = [=[
Same as |match()|, but return a |List|. The first item in the Same as |match()|, but return a |List|. The first item in the
list is the matched string, same as what matchstr() would list is the matched string, same as what |matchstr()| would
return. Following items are submatches, like "\1", "\2", etc. return. Following items are submatches, like "\1", "\2", etc.
in |:substitute|. When an optional submatch didn't match an in |:substitute|. When an optional submatch didn't match an
empty string is used. Example: >vim empty string is used. Example: >vim
@@ -8856,7 +8856,7 @@ M.funcs = {
let start = reltime() let start = reltime()
call MyFunction() call MyFunction()
let seconds = reltimefloat(reltime(start)) let seconds = reltimefloat(reltime(start))
See the note of reltimestr() about overhead. See the note of |reltimestr()| about overhead.
Also see |profiling|. Also see |profiling|.
If there is an error an empty string is returned If there is an error an empty string is returned
@@ -8878,7 +8878,7 @@ M.funcs = {
echo reltimestr(reltime(start)) echo reltimestr(reltime(start))
<Note that overhead for the commands will be added to the time. <Note that overhead for the commands will be added to the time.
Leading spaces are used to make the string align nicely. You Leading spaces are used to make the string align nicely. You
can use split() to remove it. >vim can use |split()| to remove it. >vim
echo split(reltimestr(reltime(start)))[0] echo split(reltimestr(reltime(start)))[0]
<Also see |profiling|. <Also see |profiling|.
If there is an error an empty string is returned If there is an error an empty string is returned
@@ -11131,7 +11131,7 @@ M.funcs = {
When {how} is given and it is 'l' then the current collation When {how} is given and it is 'l' then the current collation
locale is used for ordering. Implementation details: locale is used for ordering. Implementation details:
strcoll() is used to compare strings. See |:language| check strcoll() is used to compare strings. See |:language| to check
or set the collation locale. |v:collate| can also be used to or set the collation locale. |v:collate| can also be used to
check the current locale. Sorting using the locale typically check the current locale. Sorting using the locale typically
ignores case. Example: >vim ignores case. Example: >vim
@@ -11373,7 +11373,7 @@ M.funcs = {
< <
These characters indicate the state, generally indicating that These characters indicate the state, generally indicating that
something is busy: something is busy:
m halfway a mapping, :normal command, feedkeys() or m halfway a mapping, :normal command, |feedkeys()| or
stuffed command stuffed command
o operator pending, e.g. after |d| o operator pending, e.g. after |d|
a Insert mode autocomplete active a Insert mode autocomplete active
@@ -11946,7 +11946,7 @@ M.funcs = {
tags = { 'E935' }, tags = { 'E935' },
desc = [=[ desc = [=[
Only for an expression in a |:substitute| command or Only for an expression in a |:substitute| command or
substitute() function. |substitute()| function.
Returns the {nr}th submatch of the matched text. When {nr} Returns the {nr}th submatch of the matched text. When {nr}
is 0 the whole matched text is returned. is 0 the whole matched text is returned.
Note that a NL in the string can stand for a line break of a Note that a NL in the string can stand for a line break of a
@@ -11961,7 +11961,7 @@ M.funcs = {
|substitute()| this list will always contain one or zero |substitute()| this list will always contain one or zero
items, since there are no real line breaks. items, since there are no real line breaks.
When substitute() is used recursively only the submatches in When |substitute()| is used recursively only the submatches in
the current (deepest) call can be obtained. the current (deepest) call can be obtained.
Returns an empty string or list on error. Returns an empty string or list on error.
@@ -12146,7 +12146,7 @@ M.funcs = {
for that mode. When {mode} is omitted, or an invalid value is for that mode. When {mode} is omitted, or an invalid value is
used, the attributes for the currently active highlighting are used, the attributes for the currently active highlighting are
used (GUI or cterm). used (GUI or cterm).
Use synIDtrans() to follow linked highlight groups. Use |synIDtrans()| to follow linked highlight groups.
{what} result {what} result
"name" the name of the syntax item "name" the name of the syntax item
"fg" foreground color (GUI: color name used to set "fg" foreground color (GUI: color name used to set
@@ -12656,7 +12656,7 @@ M.funcs = {
base = 1, base = 1,
desc = [=[ desc = [=[
Stop a timer. The timer callback will no longer be invoked. Stop a timer. The timer callback will no longer be invoked.
{timer} is an ID returned by timer_start(), thus it must be a {timer} is an ID returned by |timer_start()|, thus it must be a
Number. If {timer} does not exist there is no error. Number. If {timer} does not exist there is no error.
]=], ]=],
@@ -12938,7 +12938,7 @@ M.funcs = {
Returns -1 if the arguments are invalid or if there are less Returns -1 if the arguments are invalid or if there are less
than {idx} bytes in {string}. If there are exactly {idx} than {idx} bytes in {string}. If there are exactly {idx}
bytes the length of the string in UTF-16 code units is bytes, the length of the string in UTF-16 code units is
returned. returned.
See |byteidx()| and |byteidxcomp()| for getting the byte index See |byteidx()| and |byteidxcomp()| for getting the byte index