Commit: runtime(doc): Tweak documentation style

[Christian Brabandt]

runtime(doc): Tweak documentation style

Commit: https://github.com/vim/vim/commit/5ca1ea83ad79c8d1ebd25e61c91f1199c9bc4f09
Author: Hirohito Higashi <h.eas...@gmail.com>
Date: Thu Aug 21 15:34:58 2025 -0400

runtime(doc): Tweak documentation style

closes: https://github.com/vim/vim/issues/18078

Signed-off-by: Hirohito Higashi <h.eas...@gmail.com>
Signed-off-by: Christian Brabandt <c...@256bit.org>

diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index e0083eda6..132b3f6af 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -1,4 +1,4 @@
-*options.txt* For Vim version 9.1. Last change: 2025 Aug 20
+*options.txt* For Vim version 9.1. Last change: 2025 Aug 21


VIM REFERENCE MANUAL by Bram Moolenaar
@@ -922,8 +922,8 @@ A jump table for the options with a short description can be found at |Q_op|.
'autocompletedelay' 'acl' number (default 0)
global
Delay in milliseconds before the autocomplete menu appears after
- typing. If you prefer it not to open too quickly, set this value
- slightly above your typing speed. See |ins-autocompletion|.
+ typing. If you prefer it not to open too quickly, set this value
+ slightly above your typing speed. See |ins-autocompletion|.

*'autoindent'* *'ai'* *'noautoindent'* *'noai'*
'autoindent' 'ai' boolean (default off)
diff --git a/runtime/doc/pattern.txt b/runtime/doc/pattern.txt
index 414b0f97d..51280317a 100644
--- a/runtime/doc/pattern.txt
+++ b/runtime/doc/pattern.txt
@@ -1,4 +1,4 @@
-*pattern.txt* For Vim version 9.1. Last change: 2025 Aug 13
+*pattern.txt* For Vim version 9.1. Last change: 2025 Aug 21


VIM REFERENCE MANUAL by Bram Moolenaar
@@ -1505,11 +1505,11 @@ Fuzzy matching scores how well a string matches a pattern when the pattern
characters appear in order but not necessarily contiguously.

Example: >
- Pattern: "vim"
- Candidates: "vim" -> perfect
- "vimeo" -> good (v i m)
- "voice mail" -> weaker (v _ i _ _ _ m)
- "vintage" -> no match (no "m")
+ Pattern: "vim"
+ Candidates: "vim" -> perfect
+ "vimeo" -> good (v i m)
+ "voice mail" -> weaker (v _ i _ _ _ m)
+ "vintage" -> no match (no "m")
<
If the search string has multiple words, each word is matched separately and
may appear in any order in the candidate. For example "get pat" matches
diff --git a/runtime/doc/remote.txt b/runtime/doc/remote.txt
index cf17e3549..cf3ff78ba 100644
--- a/runtime/doc/remote.txt
+++ b/runtime/doc/remote.txt
@@ -1,4 +1,4 @@
-*remote.txt* For Vim version 9.1. Last change: 2025 Aug 18
+*remote.txt* For Vim version 9.1. Last change: 2025 Aug 21


VIM REFERENCE MANUAL by Bram Moolenaar
@@ -77,10 +77,10 @@ The following command line arguments are available:
--serverlist Output a list of server names.
*--clientserver*
--clientserver {method} Use the specified method {method} as the
- backend for clientserver functionality. Can
+ backend for clientserver functionality. Can
either be "socket" or "x11".
- {only available when Vim is compiled with both
- |+X11| and |+socketserver| features}
+ {only available when compiled with both |+X11|
+ and |+socketserver| features}


Examples ~
@@ -225,9 +225,9 @@ The communication between client and server is done using Unix domain sockets.
These sockets are either placed in these directories in the following order of
availability:
1. "$XDG_RUTIME_DIR/vim" if $XDG_RUNTIME_DIR is set in the environment.
- 2. "$TMPDIR/vim-[uid]", where "[uid]" is the uid of the user. This
+ 2. "$TMPDIR/vim-[uid]", where "[uid]" is the uid of the user. This
directory will have the access permissions set to 700 so only the user
- can read or write from/to it. If $TMPDIR is not set, "/tmp" is used.
+ can read or write from/to it. If $TMPDIR is not set, "/tmp" is used.

*socketserver-name*
When specifying the server id/name, it can be taken as a generic name or an
@@ -238,9 +238,9 @@ placed in the above common directories. Note that a server id/name can only
contain slashes "/" if it is taken as a path, so names such as "abc/dir" will
be invalid.

-Socket server functionality is available in both GTK GUI and terminal versions of
-Vim. Unless Vim is compiled with |+autoservername| feature, the socket server
-will have to started explicitly, just like X11, even in the GUI.
+Socket server functionality is available in both GTK GUI and terminal versions
+of Vim. Unless Vim is compiled with |+autoservername| feature, the socket
+server will have to started explicitly, just like X11, even in the GUI.

If Vim crashes or does not exit cleanly, the socket server will not remove the
socket file and it will be left around. This is generally not a problem,

[Christian Brabandt]

runtime(doc): Tweak documentation style

Commit: https://github.com/vim/vim/commit/e0196f3e2772c02d79beb7d0f2d6450938884551
Author: Hirohito Higashi <h.eas...@gmail.com>
Date: Fri Aug 29 18:17:40 2025 +0200

runtime(doc): Tweak documentation style

closes: https://github.com/vim/vim/issues/18155

Signed-off-by: Hirohito Higashi <h.eas...@gmail.com>
Signed-off-by: Christian Brabandt <c...@256bit.org>

diff --git a/runtime/doc/autocmd.txt b/runtime/doc/autocmd.txt
index 37b3e3509..d5b8c6a62 100644
--- a/runtime/doc/autocmd.txt
+++ b/runtime/doc/autocmd.txt
@@ -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

@@ -1315,7 +1315,7 @@ TermResponseAll After the response to |t_RV|, |t_RC|, |t_RS|,
"version",
"cursorblink",
"cursorshape",
- "ambiguouswidth"
+ "ambiguouswidth",
"osc"
Note that this event may be triggered halfway
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
encounters "foreground" and "background"
values.
-
-
*TextChanged*
TextChanged After a change was made to the text in the
current buffer in Normal mode. That is after
diff --git a/runtime/doc/eval.txt b/runtime/doc/eval.txt
index edc9bf33a..efd6218d4 100644
--- a/runtime/doc/eval.txt
+++ b/runtime/doc/eval.txt
@@ -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

@@ -972,8 +972,8 @@ is not available it returns -1 or the default value you specify: >

Blob iteration ~

-The |:for| loop executes commands for each byte of a Blob. The loop variable is
-set to each byte in the Blob. Example: >
+The |:for| loop executes commands for each byte of a Blob. The loop variable
+is set to each byte in the Blob. Example: >
:for byte in 0z112233
: call Doit(byte)
: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.
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|
-for possible index values. If the index is out of range this results in an
-error. Example: >
+If expr10 is a |List| then it results the item at index expr1. See
+|list-index| for possible index values. If the index is out of range this
+results in an error. Example: >
:let item = mylist[-1] " get last item

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.
See 'clipmethod' for more details.

-
*v:cmdarg* *cmdarg-variable*
v:cmdarg This variable is used for two purposes:
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
doing so is NOT recommended, because it is disruptive to
other scripts. It is also unlikely to achieve the desired
- result because the |:colorscheme| and |:highlight| commands will
- both automatically load all `colors/lists/default.vim` color
- scripts.
+ result because the |:colorscheme| and |:highlight| commands
+ will both automatically load all `colors/lists/default.vim`
+ color scripts.

You can make changes to that file, but make sure to add new
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
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).
- When |python-stable-abi| is used, this will be the minimum Python
- version that you can use instead. (e.g. if v:python3_version
- indicates 3.9, you can use 3.9, 3.10, or anything above).
+ When |python-stable-abi| is used, this will be the minimum
+ Python version that you can use instead. (e.g. if
+ 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
versioning conventions. Do the following to have a
@@ -2861,16 +2861,16 @@ v:t_enumvalue Value of |enumvalue| type. Read-only. See: |type()|
*v:t_tuple* *t_tuple-variable*
v:t_tuple Value of |Tuple| type. Read-only. See: |type()|

- *v:termresponse* *termresponse-variable*
+ *v:termresponse* *termresponse-variable*
v:termresponse The escape sequence returned by the terminal for the |t_RV|
termcap entry. It is set when Vim receives an escape sequence
that starts with ESC [ or CSI, then '>' or '?' and ends in a
'c', with only digits and ';' in between.
- When this option is set, the TermResponse autocommand event is
- fired, so that you can react to the response from the
+ When this variable is set, the TermResponse autocommand event
+ is fired, so that you can react to the response from the
terminal. The TermResponseAll event is also fired, with
- <amatch> set to "version". You can use |terminalprops()| to see
- what Vim figured out about the terminal.
+ <amatch> set to "version". You can use |terminalprops()| to
+ see what Vim figured out about the terminal.
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
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|.
{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|
termcap entry. This is used to find out whether the terminal
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".

- *v:termstyleresp*
+ *v:termstyleresp* *termstyleresp-variable*
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
cursor is. This is used by |term_getcursor()|. When this
- option is set, the TermResponseAll autocommand event is fired,
- with <amatch> set to "cursorshape".
+ variable is set, the TermResponseAll autocommand event is
+ 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|
termcap entry. This is used to find out what the terminal
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.
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|
termcap entry. This is used to find out what the terminal
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|
termcap entry. This is used to find out what the terminal
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".

- *v:termda1*
+ *v:termda1* *termda1-variable*
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
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
- 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>
set to "osc". Also used to set the |v:termrbgresp| and
|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 Last given warning message. It's allowed to set this variable.

- *v:wayland_display*
+ *v:wayland_display* *wayland_display-variable*
v:wayland_display
The name of the Wayland display that Vim is connected to.
Equivalent to the $WAYLAND_DISPLAY environment variable.
@@ -3356,7 +3356,8 @@ text...
One or more items from a |List| can be removed: >
:unlet list[3] " remove fourth item
: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
< This is especially useful to clean up used global
@@ -3487,7 +3488,7 @@ text...
- In |Vim9| script an error is given.
- In legacy script this is silently ignored.

-:if {expr1} *:if* *:end* *:endif* *:en* *E171* *E579* *E580*
+:if {expr1} *:if* *:end* *:endif* *:en* *E171* *E579* *E580*
:en[dif] Execute the commands until the next matching `:else`
or `:endif` if {expr1} evaluates to non-zero.
Although the short forms work, it is recommended to
@@ -3825,8 +3826,9 @@ text...
message in the |message-history|. When used in a
script or function the line number will be added.
Spaces are placed between the arguments as with the
- `:echomsg` command. When used inside a try conditional,
- the message is raised as an error exception instead
+ `:echomsg` command. When used inside a try
+ conditional, the message is raised as an error
+ exception instead
(see |try-echoerr|).
Example: >
: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
specific filetypes by setting the "<filetype>_exec" variable (|plugin_exec|).

-It returns |true| or |false| to indicate whether the plugin should run the given
-executable. It takes the following arguments:
+It returns |true| or |false| to indicate whether the plugin should run the
+given executable. It takes the following arguments:

argument type ~

diff --git a/runtime/doc/tags b/runtime/doc/tags
index 3a4a07bf0..37484a1d1 100644
--- a/runtime/doc/tags
+++ b/runtime/doc/tags
@@ -10893,6 +10893,7 @@ term_setrestore() terminal.txt /*term_setrestore()*
term_setsize() terminal.txt /*term_setsize()*
term_start() terminal.txt /*term_start()*
term_wait() terminal.txt /*term_wait()*
+termblinkresp-variable eval.txt /*termblinkresp-variable*
termcap term.txt /*termcap*
termcap-changed version4.txt /*termcap-changed*
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-options term.txt /*termcap-options*
termcap-title term.txt /*termcap-title*
+termda1-variable eval.txt /*termda1-variable*
termdebug-commands terminal.txt /*termdebug-commands*
termdebug-communication terminal.txt /*termdebug-communication*
termdebug-customizing terminal.txt /*termdebug-customizing*
@@ -10963,7 +10965,12 @@ terminal-window terminal.txt /*terminal-window*
terminal.txt terminal.txt /*terminal.txt*
terminalprops() builtin.txt /*terminalprops()*
terminfo term.txt /*terminfo*
+termosc-variable eval.txt /*termosc-variable*
+termrbgresp-variable eval.txt /*termrbgresp-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*
test-functions usr_41.txt /*test-functions*
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-useful wayland.txt /*wayland-useful*
wayland.txt wayland.txt /*wayland.txt*
+wayland_display-variable eval.txt /*wayland_display-variable*
wdl-syntax syntax.txt /*wdl-syntax*
wdl.vim syntax.txt /*wdl.vim*
white-space pattern.txt /*white-space*