runtime(doc): Tweak documentation style

closes: #18155

Signed-off-by: Hirohito Higashi <h.east.727@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
Hirohito Higashi
2025-08-29 18:17:40 +02:00
committed by Christian Brabandt
parent 4fec4bb7a5
commit e0196f3e27
3 changed files with 50 additions and 42 deletions

View File

@ -1,4 +1,4 @@
*autocmd.txt* For Vim version 9.1. Last change: 2025 Aug 27 *autocmd.txt* For Vim version 9.1. Last change: 2025 Aug 29
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -1315,7 +1315,7 @@ TermResponseAll After the response to |t_RV|, |t_RC|, |t_RS|,
"version", "version",
"cursorblink", "cursorblink",
"cursorshape", "cursorshape",
"ambiguouswidth" "ambiguouswidth",
"osc" "osc"
Note that this event may be triggered halfway Note that this event may be triggered halfway
executing another event, especially if file I/O, executing another event, especially if file I/O,
@ -1330,8 +1330,6 @@ TermResponseAll After the response to |t_RV|, |t_RC|, |t_RS|,
TermResponseAll autocommand events when it TermResponseAll autocommand events when it
encounters "foreground" and "background" encounters "foreground" and "background"
values. values.
*TextChanged* *TextChanged*
TextChanged After a change was made to the text in the TextChanged After a change was made to the text in the
current buffer in Normal mode. That is after current buffer in Normal mode. That is after

View File

@ -1,4 +1,4 @@
*eval.txt* For Vim version 9.1. Last change: 2025 Aug 27 *eval.txt* For Vim version 9.1. Last change: 2025 Aug 29
VIM REFERENCE MANUAL by Bram Moolenaar VIM REFERENCE MANUAL by Bram Moolenaar
@ -972,8 +972,8 @@ is not available it returns -1 or the default value you specify: >
Blob iteration ~ Blob iteration ~
The |:for| loop executes commands for each byte of a Blob. The loop variable is The |:for| loop executes commands for each byte of a Blob. The loop variable
set to each byte in the Blob. Example: > is set to each byte in the Blob. Example: >
:for byte in 0z112233 :for byte in 0z112233
: call Doit(byte) : call Doit(byte)
:endfor :endfor
@ -1547,9 +1547,9 @@ String. A negative index always results in an empty string (reason: backward
compatibility). Use [-1:] to get the last byte or character. compatibility). Use [-1:] to get the last byte or character.
In Vim9 script a negative index is used like with a list: count from the end. In Vim9 script a negative index is used like with a list: count from the end.
If expr10 is a |List| then it results the item at index expr1. See |list-index| If expr10 is a |List| then it results the item at index expr1. See
for possible index values. If the index is out of range this results in an |list-index| for possible index values. If the index is out of range this
error. Example: > results in an error. Example: >
:let item = mylist[-1] " get last item :let item = mylist[-1] " get last item
Generally, if a |List| index is equal to or higher than the length of the Generally, if a |List| index is equal to or higher than the length of the
@ -2251,7 +2251,6 @@ v:clipmethod The current method of accessing the clipboard that is being
unavailable. unavailable.
See 'clipmethod' for more details. See 'clipmethod' for more details.
*v:cmdarg* *cmdarg-variable* *v:cmdarg* *cmdarg-variable*
v:cmdarg This variable is used for two purposes: v:cmdarg This variable is used for two purposes:
1. The extra arguments given to a file read/write command. 1. The extra arguments given to a file read/write command.
@ -2318,9 +2317,9 @@ v:colornames A dictionary that maps color names to hex color strings. These
It is possible to remove entries from this dictionary but It is possible to remove entries from this dictionary but
doing so is NOT recommended, because it is disruptive to doing so is NOT recommended, because it is disruptive to
other scripts. It is also unlikely to achieve the desired other scripts. It is also unlikely to achieve the desired
result because the |:colorscheme| and |:highlight| commands will result because the |:colorscheme| and |:highlight| commands
both automatically load all `colors/lists/default.vim` color will both automatically load all `colors/lists/default.vim`
scripts. color scripts.
You can make changes to that file, but make sure to add new You can make changes to that file, but make sure to add new
keys instead of updating existing ones, otherwise Vim will skip keys instead of updating existing ones, otherwise Vim will skip
@ -2721,9 +2720,10 @@ v:python3_version
should exactly match the Python library up to the minor should exactly match the Python library up to the minor
version (e.g. 3.10.2 and 3.10.3 are compatible as the minor version (e.g. 3.10.2 and 3.10.3 are compatible as the minor
version is "10", whereas 3.9.4 and 3.10.3 are not compatible). version is "10", whereas 3.9.4 and 3.10.3 are not compatible).
When |python-stable-abi| is used, this will be the minimum Python When |python-stable-abi| is used, this will be the minimum
version that you can use instead. (e.g. if v:python3_version Python version that you can use instead. (e.g. if
indicates 3.9, you can use 3.9, 3.10, or anything above). v:python3_version indicates 3.9, you can use 3.9, 3.10, or
anything above).
This number is encoded as a hex number following Python ABI This number is encoded as a hex number following Python ABI
versioning conventions. Do the following to have a versioning conventions. Do the following to have a
@ -2866,11 +2866,11 @@ v:termresponse The escape sequence returned by the terminal for the |t_RV|
termcap entry. It is set when Vim receives an escape sequence termcap entry. It is set when Vim receives an escape sequence
that starts with ESC [ or CSI, then '>' or '?' and ends in a that starts with ESC [ or CSI, then '>' or '?' and ends in a
'c', with only digits and ';' in between. 'c', with only digits and ';' in between.
When this option is set, the TermResponse autocommand event is When this variable is set, the TermResponse autocommand event
fired, so that you can react to the response from the is fired, so that you can react to the response from the
terminal. The TermResponseAll event is also fired, with terminal. The TermResponseAll event is also fired, with
<amatch> set to "version". You can use |terminalprops()| to see <amatch> set to "version". You can use |terminalprops()| to
what Vim figured out about the terminal. see what Vim figured out about the terminal.
The response from a new xterm is: "<Esc>[> Pp ; Pv ; Pc c". Pp The response from a new xterm is: "<Esc>[> Pp ; Pv ; Pc c". Pp
is the terminal type: 0 for vt100 and 1 for vt220. Pv is the is the terminal type: 0 for vt100 and 1 for vt220. Pv is the
patch level (since this was introduced in patch 95, it's patch level (since this was introduced in patch 95, it's
@ -2879,21 +2879,21 @@ v:termresponse The escape sequence returned by the terminal for the |t_RV|
codes. This only works with xterm |xterm-codes|. codes. This only works with xterm |xterm-codes|.
{only when compiled with |+termresponse| feature} {only when compiled with |+termresponse| feature}
*v:termblinkresp* *v:termblinkresp* *termblinkresp-variable*
v:termblinkresp The escape sequence returned by the terminal for the |t_RC| v:termblinkresp The escape sequence returned by the terminal for the |t_RC|
termcap entry. This is used to find out whether the terminal termcap entry. This is used to find out whether the terminal
cursor is blinking. This is used by |term_getcursor()|. When cursor is blinking. This is used by |term_getcursor()|. When
this option is set, the TermResponseAll autocommand event is this variable is set, the TermResponseAll autocommand event is
fired, with <amatch> set to "cursorblink". fired, with <amatch> set to "cursorblink".
*v:termstyleresp* *v:termstyleresp* *termstyleresp-variable*
v:termstyleresp The escape sequence returned by the terminal for the |t_RS| v:termstyleresp The escape sequence returned by the terminal for the |t_RS|
termcap entry. This is used to find out what the shape of the termcap entry. This is used to find out what the shape of the
cursor is. This is used by |term_getcursor()|. When this cursor is. This is used by |term_getcursor()|. When this
option is set, the TermResponseAll autocommand event is fired, variable is set, the TermResponseAll autocommand event is
with <amatch> set to "cursorshape". fired, with <amatch> set to "cursorshape".
*v:termrbgresp* *v:termrbgresp* *termrbgresp-variable*
v:termrbgresp The escape sequence returned by the terminal for the |t_RB| v:termrbgresp The escape sequence returned by the terminal for the |t_RB|
termcap entry. This is used to find out what the terminal termcap entry. This is used to find out what the terminal
background color is; see 'background'. This is set by the background color is; see 'background'. This is set by the
@ -2901,27 +2901,27 @@ v:termrbgresp The escape sequence returned by the terminal for the |t_RB|
Vim, but can be set manually if you know what you are doing. Vim, but can be set manually if you know what you are doing.
Note that changing this will not do anything. Note that changing this will not do anything.
*v:termrfgresp* *v:termrfgresp* *termrfgresp-variable*
v:termrfgresp The escape sequence returned by the terminal for the |t_RF| v:termrfgresp The escape sequence returned by the terminal for the |t_RF|
termcap entry. This is used to find out what the terminal termcap entry. This is used to find out what the terminal
foreground color is. Behaves the same as |v:termrbgresp| foreground color is. Behaves the same as |v:termrbgresp|
*v:termu7resp* *v:termu7resp* *termu7resp-variable*
v:termu7resp The escape sequence returned by the terminal for the |t_u7| v:termu7resp The escape sequence returned by the terminal for the |t_u7|
termcap entry. This is used to find out what the terminal termcap entry. This is used to find out what the terminal
does with ambiguous width characters, see 'ambiwidth'. When does with ambiguous width characters, see 'ambiwidth'. When
this option is set, the TermResponseAll autocommand event is this variable is set, the TermResponseAll autocommand event is
fired, with <amatch> set to "ambiguouswidth". fired, with <amatch> set to "ambiguouswidth".
*v:termda1* *v:termda1* *termda1-variable*
v:termda1 The escape sequence returned by a primary device attributes v:termda1 The escape sequence returned by a primary device attributes
(DA1) query from the terminal. When this option is set, the (DA1) query from the terminal. When this variable is set, the
TermResponseAll autocommand event is fired, with <amatch> set TermResponseAll autocommand event is fired, with <amatch> set
to "da1". Can be used to detect OSC 52 support in a terminal. to "da1". Can be used to detect OSC 52 support in a terminal.
*v:termosc* *v:termosc* *termosc-variable*
v:termosc The escape sequence of the most recent OSC response received v:termosc The escape sequence of the most recent OSC response received
from the terminal. When this option is set, the from the terminal. When this variable is set, the
|TermResponseAll| autocommand event is fired, with <amatch> |TermResponseAll| autocommand event is fired, with <amatch>
set to "osc". Also used to set the |v:termrbgresp| and set to "osc". Also used to set the |v:termrbgresp| and
|v:termrfgresp| via the $VIMRUNTIME/plugin/colorresp.vim |v:termrfgresp| via the $VIMRUNTIME/plugin/colorresp.vim
@ -2994,7 +2994,7 @@ v:vim_did_enter Zero until most of startup is done. It is set to one just
*v:warningmsg* *warningmsg-variable* *v:warningmsg* *warningmsg-variable*
v:warningmsg Last given warning message. It's allowed to set this variable. v:warningmsg Last given warning message. It's allowed to set this variable.
*v:wayland_display* *v:wayland_display* *wayland_display-variable*
v:wayland_display v:wayland_display
The name of the Wayland display that Vim is connected to. The name of the Wayland display that Vim is connected to.
Equivalent to the $WAYLAND_DISPLAY environment variable. Equivalent to the $WAYLAND_DISPLAY environment variable.
@ -3356,7 +3356,8 @@ text...
One or more items from a |List| can be removed: > One or more items from a |List| can be removed: >
:unlet list[3] " remove fourth item :unlet list[3] " remove fourth item
:unlet list[3:] " remove fourth item to last :unlet list[3:] " remove fourth item to last
< One item from a |Dictionary| can be removed at a time: > < One item from a |Dictionary| can be removed at a time:
>
:unlet dict['two'] :unlet dict['two']
:unlet dict.two :unlet dict.two
< This is especially useful to clean up used global < This is especially useful to clean up used global
@ -3825,8 +3826,9 @@ text...
message in the |message-history|. When used in a message in the |message-history|. When used in a
script or function the line number will be added. script or function the line number will be added.
Spaces are placed between the arguments as with the Spaces are placed between the arguments as with the
`:echomsg` command. When used inside a try conditional, `:echomsg` command. When used inside a try
the message is raised as an error exception instead conditional, the message is raised as an error
exception instead
(see |try-echoerr|). (see |try-echoerr|).
Example: > Example: >
:echoerr "This script just failed!" :echoerr "This script just failed!"
@ -5172,8 +5174,8 @@ to execute the given executable. For security reasons users may not want to
have Vim execute random executables or may have forbidden to do so for have Vim execute random executables or may have forbidden to do so for
specific filetypes by setting the "<filetype>_exec" variable (|plugin_exec|). specific filetypes by setting the "<filetype>_exec" variable (|plugin_exec|).
It returns |true| or |false| to indicate whether the plugin should run the given It returns |true| or |false| to indicate whether the plugin should run the
executable. It takes the following arguments: given executable. It takes the following arguments:
argument type ~ argument type ~

View File

@ -10893,6 +10893,7 @@ term_setrestore() terminal.txt /*term_setrestore()*
term_setsize() terminal.txt /*term_setsize()* term_setsize() terminal.txt /*term_setsize()*
term_start() terminal.txt /*term_start()* term_start() terminal.txt /*term_start()*
term_wait() terminal.txt /*term_wait()* term_wait() terminal.txt /*term_wait()*
termblinkresp-variable eval.txt /*termblinkresp-variable*
termcap term.txt /*termcap* termcap term.txt /*termcap*
termcap-changed version4.txt /*termcap-changed* termcap-changed version4.txt /*termcap-changed*
termcap-colors term.txt /*termcap-colors* termcap-colors term.txt /*termcap-colors*
@ -10900,6 +10901,7 @@ termcap-cursor-color term.txt /*termcap-cursor-color*
termcap-cursor-shape term.txt /*termcap-cursor-shape* termcap-cursor-shape term.txt /*termcap-cursor-shape*
termcap-options term.txt /*termcap-options* termcap-options term.txt /*termcap-options*
termcap-title term.txt /*termcap-title* termcap-title term.txt /*termcap-title*
termda1-variable eval.txt /*termda1-variable*
termdebug-commands terminal.txt /*termdebug-commands* termdebug-commands terminal.txt /*termdebug-commands*
termdebug-communication terminal.txt /*termdebug-communication* termdebug-communication terminal.txt /*termdebug-communication*
termdebug-customizing terminal.txt /*termdebug-customizing* termdebug-customizing terminal.txt /*termdebug-customizing*
@ -10963,7 +10965,12 @@ terminal-window terminal.txt /*terminal-window*
terminal.txt terminal.txt /*terminal.txt* terminal.txt terminal.txt /*terminal.txt*
terminalprops() builtin.txt /*terminalprops()* terminalprops() builtin.txt /*terminalprops()*
terminfo term.txt /*terminfo* terminfo term.txt /*terminfo*
termosc-variable eval.txt /*termosc-variable*
termrbgresp-variable eval.txt /*termrbgresp-variable*
termresponse-variable eval.txt /*termresponse-variable* termresponse-variable eval.txt /*termresponse-variable*
termrfgresp-variable eval.txt /*termrfgresp-variable*
termstyleresp-variable eval.txt /*termstyleresp-variable*
termu7resp-variable eval.txt /*termu7resp-variable*
ternary eval.txt /*ternary* ternary eval.txt /*ternary*
test-functions usr_41.txt /*test-functions* test-functions usr_41.txt /*test-functions*
test-functions-details testing.txt /*test-functions-details* test-functions-details testing.txt /*test-functions-details*
@ -11669,6 +11676,7 @@ wayland-seat wayland.txt /*wayland-seat*
wayland-selections wayland.txt /*wayland-selections* wayland-selections wayland.txt /*wayland-selections*
wayland-useful wayland.txt /*wayland-useful* wayland-useful wayland.txt /*wayland-useful*
wayland.txt wayland.txt /*wayland.txt* wayland.txt wayland.txt /*wayland.txt*
wayland_display-variable eval.txt /*wayland_display-variable*
wdl-syntax syntax.txt /*wdl-syntax* wdl-syntax syntax.txt /*wdl-syntax*
wdl.vim syntax.txt /*wdl.vim* wdl.vim syntax.txt /*wdl.vim*
white-space pattern.txt /*white-space* white-space pattern.txt /*white-space*