aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc/map.txt
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2026-10-17 11:34:02 -0400
committerGitHub <noreply@github.com>2026-10-17 11:34:02 -0400
commit0851e7dabed9fc9c019e22088029f36e9f3ec3e3 (patch)
tree35a1abb6a3d08b49e6a45ad3de089b622e1605ae /runtime/doc/map.txt
parentf8b704e019ed8194a5e873773670b263abd3dedf (diff)
downloadrneovim-master.tar.gz
rneovim-master.tar.bz2
rneovim-master.zip
docs(help): specify h4 "function signature" format #42434master
Work towards enabling ["flow" layout](https://github.com/neovim/neovim/blob/9244da12e400ec0291450a5e9400d995e7a29b83/src/gen/gen_help_html.lua#L86-L88) in all `:help` files. Problem: The final boss of vimdoc pseudo-structure: Vim's quasi-headings on function signatures and excmd docs is visually distinctive but too inconsistent for a nice parse rule. Solution: - Define the quasi-heading format as an "h4" variant, specified at `:help help-tag-heading`. - For simplicity and predictability, it is defined as any line that ends with a help tag(s) preceded by 2 or more spaces (or 1 tab). - Update existing docs. - This one-time update has a lot of changes, but is very unlikely to conflict with ported Vim-patches because (1) Vim rarely adds new *excmds* that we want, and (2) *function* docs are auto-generated. ref https://github.com/neovim/tree-sitter-vimdoc/issues/110
Diffstat (limited to 'runtime/doc/map.txt')
-rw-r--r--runtime/doc/map.txt47
1 files changed, 19 insertions, 28 deletions
diff --git a/runtime/doc/map.txt b/runtime/doc/map.txt
index ec5e95f44d..d83766c25d 100644
--- a/runtime/doc/map.txt
+++ b/runtime/doc/map.txt
@@ -868,8 +868,8 @@ you must create a mapping that first sets the 'operatorfunc' option and then
invoke the |g@| operator. After the user types the {motion} command the
specified function will be called.
- *g@* *E774* *E775*
-g@{motion} Call the function set by the 'operatorfunc' option.
+g@{motion} *g@* *E774* *E775*
+ Call the function set by the 'operatorfunc' option.
The '[ mark is positioned at the start of the text
moved over by {motion}, the '] mark on the last
character of the text.
@@ -1069,8 +1069,8 @@ Just like mappings, abbreviations can be local to a buffer. This is mostly
used in a |filetype-plugin| file. Example for a C plugin file: >
:abb <buffer> FF for (i = 0; i < ; ++i)
<
- *:ab* *:abbreviate*
-:ab[breviate] list all abbreviations. The character in the first
+:ab[breviate] *:ab* *:abbreviate*
+ list all abbreviations. The character in the first
column indicates the mode where the abbreviation is
used: 'i' for insert mode, 'c' for Command-line
mode, '!' for both. These are the same as for
@@ -1098,52 +1098,44 @@ See |:verbose-cmd| for more information.
See |:map-<expr>| for the optional <expr> argument.
See |:map-<buffer>| for the optional <buffer> argument.
- *:una* *:unabbreviate*
-:una[bbreviate] [<buffer>] {lhs}
+:una[bbreviate] [<buffer>] {lhs} *:una* *:unabbreviate*
Remove abbreviation for {lhs} from the list. If none
is found, remove abbreviations in which {lhs} matches
with the {rhs}. This is done so that you can even
remove abbreviations after expansion. To avoid
expansion insert a CTRL-V (type it twice).
- *:norea* *:noreabbrev*
-:norea[bbrev] [<expr>] [<buffer>] [lhs] [rhs]
+:norea[bbrev] [<expr>] [<buffer>] [lhs] [rhs] *:norea* *:noreabbrev*
same as ":ab", but no remapping for this {rhs}
- *:ca* *:cab* *:cabbrev*
-:ca[bbrev] [<expr>] [<buffer>] [lhs] [rhs]
+:ca[bbrev] [<expr>] [<buffer>] [lhs] [rhs] *:ca* *:cab* *:cabbrev*
same as ":ab", but for Command-line mode only.
- *:cuna* *:cunabbrev*
-:cuna[bbrev] [<buffer>] {lhs}
+:cuna[bbrev] [<buffer>] {lhs} *:cuna* *:cunabbrev*
Same as ":una", but for Command-line mode only.
- *:cnorea* *:cnoreabbrev*
-:cnorea[bbrev] [<expr>] [<buffer>] [lhs] [rhs]
+:cnorea[bbrev] [<expr>] [<buffer>] [lhs] [rhs] *:cnorea* *:cnoreabbrev*
same as ":ab", but for Command-line mode only and no
remapping for this {rhs}
- *:ia* *:iabbrev*
-:ia[bbrev] [<expr>] [<buffer>] [lhs] [rhs]
+:ia[bbrev] [<expr>] [<buffer>] [lhs] [rhs] *:ia* *:iabbrev*
same as ":ab", but for Insert mode only.
- *:iuna* *:iunabbrev*
-:iuna[bbrev] [<buffer>] {lhs}
+:iuna[bbrev] [<buffer>] {lhs} *:iuna* *:iunabbrev*
Same as ":una", but for insert mode only.
- *:inorea* *:inoreabbrev*
-:inorea[bbrev] [<expr>] [<buffer>] [lhs] [rhs]
+:inorea[bbrev] [<expr>] [<buffer>] [lhs] [rhs] *:inorea* *:inoreabbrev*
same as ":ab", but for Insert mode only and no
remapping for this {rhs}
- *:abc* *:abclear*
-:abc[lear] [<buffer>] Remove all abbreviations.
+:abc[lear] [<buffer>] *:abc* *:abclear*
+ Remove all abbreviations.
- *:iabc* *:iabclear*
-:iabc[lear] [<buffer>] Remove all abbreviations for Insert mode.
+:iabc[lear] [<buffer>] *:iabc* *:iabclear*
+ Remove all abbreviations for Insert mode.
- *:cabc* *:cabclear*
-:cabc[lear] [<buffer>] Remove all abbreviations for Command-line mode.
+:cabc[lear] [<buffer>] *:cabc* *:cabclear*
+ Remove all abbreviations for Command-line mode.
*using_CTRL-V*
It is possible to use special characters in the rhs of an abbreviation.
@@ -1305,8 +1297,7 @@ last defined and any completion argument. Example: >
<
See |:verbose-cmd| for more information.
- *E174* *E182*
-:com[mand][!] [{attr}...] {cmd} {repl}
+:com[mand][!] [{attr}...] {cmd} {repl} *E174* *E182*
Define a user command. The name of the command is
{cmd} and its replacement text is {repl}. The
command's attributes (see below) are {attr}. If the