aniani/vim
0
0
Fork 1
mirror of https://github.com/vim/vim.git synced 2025-08-29 20:33:37 -04:00
Code

runtime(doc): Normalise builtin-function optional parameter formatting

Browse Source 
These should generally be formatted as func([{arg}]) and referenced as
{arg} in the description.

closes: #14438

Signed-off-by: Doug Kearns <dougkearns@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
Doug Kearns 2024-04-07 17:42:17 +02:00 committed by Christian Brabandt
parent 3c4d2e7a09
commit 9cd9e759ab
No known key found for this signature in database
GPG Key ID: F3F92DA383FDDE09
2 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
runtime/doc/builtin.txt
View File

@ -1,4 +1,4 @@
*builtin.txt* For Vim version 9.1. Last change: 2024 Apr 04 *builtin.txt* For Vim version 9.1. Last change: 2024 Apr 07
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -220,12 +220,12 @@ getbufvar({buf}, {varname} [, {def}])
any variable {varname} in buffer {buf} any variable {varname} in buffer {buf}
getcellwidths() List get character cell width overrides getcellwidths() List get character cell width overrides
getchangelist([{buf}]) List list of change list items getchangelist([{buf}]) List list of change list items
getchar([expr]) Number or String getchar([{expr}]) Number or String
get one character from the user get one character from the user
getcharmod() Number modifiers for the last typed character getcharmod() Number modifiers for the last typed character
getcharpos({expr}) List position of cursor, mark, etc. getcharpos({expr}) List position of cursor, mark, etc.
getcharsearch() Dict last character search getcharsearch() Dict last character search
getcharstr([expr]) String get one character from the user getcharstr([{expr}]) String get one character from the user
getcmdcompltype() String return the type of the current getcmdcompltype() String return the type of the current
command-line completion command-line completion
getcmdline() String return the current command-line getcmdline() String return the current command-line
@ -398,7 +398,7 @@ menu_info({name} [, {mode}]) Dict get menu item information
min({expr}) Number minimum value of items in {expr} min({expr}) Number minimum value of items in {expr}
mkdir({name} [, {flags} [, {prot}]]) mkdir({name} [, {flags} [, {prot}]])
Number create directory {name} Number create directory {name}
mode([expr]) String current editing mode mode([{expr}]) String current editing mode
mzeval({expr}) any evaluate |MzScheme| expression mzeval({expr}) any evaluate |MzScheme| expression
nextnonblank({lnum}) Number line nr of non-blank line >= {lnum} nextnonblank({lnum}) Number line nr of non-blank line >= {lnum}
nr2char({expr} [, {utf8}]) String single char with ASCII/UTF-8 value {expr} nr2char({expr} [, {utf8}]) String single char with ASCII/UTF-8 value {expr}
@ -699,7 +699,7 @@ test_override({expr}, {val}) none test with Vim internal overrides
test_refcount({expr}) Number get the reference count of {expr} test_refcount({expr}) Number get the reference count of {expr}
test_setmouse({row}, {col}) none set the mouse position for testing test_setmouse({row}, {col}) none set the mouse position for testing
test_settime({expr}) none set current time for testing test_settime({expr}) none set current time for testing
test_srand_seed([seed]) none set seed for testing srand() test_srand_seed([{seed}]) none set seed for testing srand()
test_unknown() any unknown value for testing test_unknown() any unknown value for testing
test_void() any void value for testing test_void() any void value for testing
timer_info([{id}]) List information about timers timer_info([{id}]) List information about timers
@ -729,7 +729,7 @@ virtcol({expr} [, {list} [, {winid}])
screen column of cursor or mark screen column of cursor or mark
virtcol2col({winid}, {lnum}, {col}) virtcol2col({winid}, {lnum}, {col})
Number byte index of a character on screen Number byte index of a character on screen
visualmode([expr]) String last visual mode used visualmode([{expr}]) String last visual mode used
wildmenumode() Number whether 'wildmenu' mode is active wildmenumode() Number whether 'wildmenu' mode is active
win_execute({id}, {command} [, {silent}]) win_execute({id}, {command} [, {silent}])
String execute {command} in window {id} String execute {command} in window {id}
@ -3455,16 +3455,16 @@ getchangelist([{buf}]) *getchangelist()*
Can also be used as a |method|: > Can also be used as a |method|: >
GetBufnr()->getchangelist() GetBufnr()->getchangelist()
getchar([expr]) *getchar()* getchar([{expr}]) *getchar()*
Get a single character from the user or input stream. Get a single character from the user or input stream.
If [expr] is omitted, wait until a character is available. If {expr} is omitted, wait until a character is available.
If [expr] is 0, only get a character when one is available. If {expr} is 0, only get a character when one is available.
Return zero otherwise. Return zero otherwise.
If [expr] is 1, only check if a character is available, it is If {expr} is 1, only check if a character is available, it is
not consumed. Return zero if no character available. not consumed. Return zero if no character available.
If you prefer always getting a string use |getcharstr()|. If you prefer always getting a string use |getcharstr()|.
Without [expr] and when [expr] is 0 a whole character or Without {expr} and when {expr} is 0 a whole character or
special key is returned. If it is a single character, the special key is returned. If it is a single character, the
result is a Number. Use |nr2char()| to convert it to a String. result is a Number. Use |nr2char()| to convert it to a String.
Otherwise a String is returned with the encoded character. Otherwise a String is returned with the encoded character.
@ -3474,11 +3474,11 @@ getchar([expr]) *getchar()*
also a String when a modifier (shift, control, alt) was used also a String when a modifier (shift, control, alt) was used
that is not included in the character. that is not included in the character.
When [expr] is 0 and Esc is typed, there will be a short delay When {expr} is 0 and Esc is typed, there will be a short delay
while Vim waits to see if this is the start of an escape while Vim waits to see if this is the start of an escape
sequence. sequence.
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.
@ -3589,13 +3589,13 @@ getcharsearch() *getcharsearch()*
< Also see |setcharsearch()|. < Also see |setcharsearch()|.
getcharstr([expr]) *getcharstr()* getcharstr([{expr}]) *getcharstr()*
Get a single character from the user or input stream as a Get a single character from the user or input stream as a
string. string.
If [expr] is omitted, wait until a character is available. If {expr} is omitted, wait until a character is available.
If [expr] is 0 or false, only get a character when one is If {expr} is 0 or false, only get a character when one is
available. Return an empty string otherwise. available. Return an empty string otherwise.
If [expr] is 1 or true, only check if a character is If {expr} is 1 or true, only check if a character is
available, it is not consumed. Return an empty string available, it is not consumed. Return an empty string
if no character is available. if no character is available.
Otherwise this works like |getchar()|, except that a number Otherwise this works like |getchar()|, except that a number
@ -6648,8 +6648,8 @@ mkdir({name} [, {flags} [, {prot}]])
GetName()->mkdir() GetName()->mkdir()
< <
*mode()* *mode()*
mode([expr]) Return a string that indicates the current mode. mode([{expr}]) Return a string that indicates the current mode.
If [expr] is supplied and it evaluates to a non-zero Number or If {expr} is supplied and it evaluates to a non-zero Number or
a non-empty String (|non-zero-arg|), then the full mode is a non-empty String (|non-zero-arg|), then the full mode is
returned, otherwise only the first letter is returned. returned, otherwise only the first letter is returned.
Also see |state()|. Also see |state()|.

6
runtime/doc/testing.txt
View File

@ -1,4 +1,4 @@
*testing.txt* For Vim version 9.1. Last change: 2024 Feb 18 *testing.txt* For Vim version 9.1. Last change: 2024 Apr 07
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -438,8 +438,8 @@ test_settime({expr}) *test_settime()*
GetTime()->test_settime() GetTime()->test_settime()
test_srand_seed([seed]) *test_srand_seed()* test_srand_seed([{seed}]) *test_srand_seed()*
When [seed] is given this sets the seed value used by When {seed} is given this sets the seed value used by
`srand()`. When omitted the test seed is removed. `srand()`. When omitted the test seed is removed.