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/digraph.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/digraph.txt')
| -rw-r--r-- | runtime/doc/digraph.txt | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/runtime/doc/digraph.txt b/runtime/doc/digraph.txt index 75e2e3344d..7a7d0e9228 100644 --- a/runtime/doc/digraph.txt +++ b/runtime/doc/digraph.txt @@ -19,12 +19,11 @@ An alternative is using the 'keymap' option. ============================================================================== 1. Defining digraphs *digraphs-define* - *:dig* *:digraphs* -:dig[raphs][!] Show currently defined digraphs. +:dig[raphs][!] *:dig* *:digraphs* + Show currently defined digraphs. With [!] headers are used to make it a bit easier to find a specific character. - *E104* *E39* -:dig[raphs] {char1}{char2} {number} ... +:dig[raphs] {char1}{char2} {number} ... *E104* *E39* Add digraph {char1}{char2} to the list. {number} is the decimal representation of the character. Normally it is the Unicode character, see |digraph-encoding|. @@ -65,8 +64,9 @@ This defines the "oe" digraph for a character that is number 339 in Unicode. 2. Using digraphs *digraphs-use* There are two methods to enter digraphs: *i_digraph* - CTRL-K {char1} {char2} or - {char1} <BS> {char2} +- CTRL-K {char1} {char2} +- {char1} <BS> {char2} + The first is always available; the second only when the 'digraph' option is set. |