diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2026-10-17 11:34:02 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2026-10-17 11:34:02 -0400 |
| commit | 0851e7dabed9fc9c019e22088029f36e9f3ec3e3 (patch) | |
| tree | 35a1abb6a3d08b49e6a45ad3de089b622e1605ae /runtime/doc/visual.txt | |
| parent | f8b704e019ed8194a5e873773670b263abd3dedf (diff) | |
| download | rneovim-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/visual.txt')
| -rw-r--r-- | runtime/doc/visual.txt | 52 |
1 files changed, 26 insertions, 26 deletions
diff --git a/runtime/doc/visual.txt b/runtime/doc/visual.txt index 2dc3659d6e..9d898e708a 100644 --- a/runtime/doc/visual.txt +++ b/runtime/doc/visual.txt @@ -48,8 +48,8 @@ position. ============================================================================== 2. Starting and stopping Visual mode *visual-start* - *v* *charwise-visual* -[count]v Start Visual mode per character. +[count]v *v* *charwise-visual* + Start Visual mode per character. With [count] select the same number of characters or lines as used for the last Visual operation, but at the current cursor position, multiplied by [count]. @@ -61,16 +61,16 @@ position. cursor right N * [count] characters. One less when 'selection' is not "exclusive". - *V* *linewise-visual* -[count]V Start Visual mode linewise. +[count]V *V* *linewise-visual* + Start Visual mode linewise. With [count] select the same number of lines as used for the last Visual operation, but at the current cursor position, multiplied by [count]. When there was no previous Visual operation [count] lines are selected. - *CTRL-V* *blockwise-visual* -[count]CTRL-V Start Visual mode blockwise. +[count]CTRL-V *CTRL-V* *blockwise-visual* + Start Visual mode blockwise. If you use <Esc>, click the left mouse button or use any command that does a jump to another buffer while in Visual mode, the highlighting stops @@ -87,8 +87,8 @@ Visual Normal blockwise Visual linewise Visual blockwise Visual Visual Normal linewise Visual linewise Visual Visual blockwise Visual Normal - *gv* *v_gv* *reselect-Visual* -gv Starts Visual mode with the previous Visual area and +gv *gv* *v_gv* *reselect-Visual* + Starts Visual mode with the previous Visual area and mode. In Visual mode the current and the previous Visual area are exchanged. After using "p" or "P" in Visual mode the text that was put will be selected. @@ -98,8 +98,8 @@ gv Starts Visual mode with the previous Visual area and object) does not update the previous ("gv") area (nor |'<| |'>|, |visualmode()|). - *gn* *v_gn* -gn Searches forward for the last-used search pattern, +gn *gn* *v_gn* + Searches forward for the last-used search pattern, like with `n`, and starts Visual mode to select the match. If the cursor is on the match, visually selects it. If an operator is pending, operates on the match. @@ -114,8 +114,8 @@ gn Searches forward for the last-used search pattern, Note: Unlike `n` the search direction does not depend on the previous search command. - *gN* *v_gN* -gN Like |gn| but searches backward, like with `N`. +gN *gN* *v_gN* + Like |gn| but searches backward, like with `N`. *<LeftMouse>* <LeftMouse> Set the current cursor position. If Visual mode is @@ -175,8 +175,8 @@ If you want to highlight exactly the same area as the last time, you can use For example <A-x> acts like <Esc>x if <A-x> does not have a visual-mode mapping. - *v_CTRL-C* -CTRL-C In Visual mode: Stop Visual mode. When insert mode is +CTRL-C *v_CTRL-C* + In Visual mode: Stop Visual mode. When insert mode is pending (the mode message shows "-- (insert) VISUAL --"), it is also stopped. On MS-Windows, you may need to press CTRL-Break. @@ -184,15 +184,15 @@ CTRL-C In Visual mode: Stop Visual mode. When insert mode is ============================================================================== 3. Changing the Visual area *visual-change* - *v_o* -o Go to Other end of highlighted text: The current +o *v_o* + Go to Other end of highlighted text: The current cursor position becomes the start of the highlighted text and the cursor is moved to the other end of the highlighted text. The highlighted area remains the same. - *v_O* -O Go to Other end of highlighted text. This is like +O *v_O* + Go to Other end of highlighted text. This is like "o", but in Visual block mode the cursor moves to the other corner in the same line. When the corner is at a character that occupies more than one position on @@ -577,25 +577,25 @@ mode started, Insert mode mappings are applied to this character. This may cause some confusion, because it means Insert mode mappings apply to a character typed in Select mode. Language mappings apply as well. - *gV* *v_gV* -gV Avoid the automatic reselection of the Visual area +gV *gV* *v_gV* + Avoid the automatic reselection of the Visual area after a Select mode mapping or menu has finished. Put this just before the end of the mapping or menu. At least it should be after any operations on the selection. - *gh* -gh Start Select mode, charwise. This is like "v", +gh *gh* + Start Select mode, charwise. This is like "v", but starts Select mode instead of Visual mode. Mnemonic: "get highlighted". - *gH* -gH Start Select mode, linewise. This is like "V", +gH *gH* + Start Select mode, linewise. This is like "V", but starts Select mode instead of Visual mode. Mnemonic: "get Highlighted". - *g_CTRL-H* -g CTRL-H Start Select mode, blockwise. This is like CTRL-V, +g CTRL-H *g_CTRL-H* + Start Select mode, blockwise. This is like CTRL-V, but starts Select mode instead of Visual mode. Mnemonic: "get Highlighted". |