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/syntax.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/syntax.txt')
| -rw-r--r-- | runtime/doc/syntax.txt | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/runtime/doc/syntax.txt b/runtime/doc/syntax.txt index 82f4386d69..8736395173 100644 --- a/runtime/doc/syntax.txt +++ b/runtime/doc/syntax.txt @@ -534,8 +534,8 @@ defines/constants are supported. Some special violation of coding standards will be signalled when one specify in ones |init.vim|: > let baan_code_stds=1 - -*baan-folding* +< + *baan-folding* Syntax folding can be enabled at various levels through the variables mentioned below (Set those in your |init.vim|). The more complex folding on @@ -5021,8 +5021,8 @@ groups, but colorschemes are expected to cover all of them. Under each tag, the corresponding highlight groups are highlighted using the current colorscheme. - *:colo* *:colorscheme* *E185* -:colo[rscheme] Output the name of the currently active color scheme. +:colo[rscheme] *:colo* *:colorscheme* *E185* + Output the name of the currently active color scheme. This is basically the same as > :echo g:colors_name < In case g:colors_name has not been defined :colo will @@ -5057,8 +5057,8 @@ colorscheme. :hi[ghlight] {group-name} List one highlight group. - *highlight-clear* *:hi-clear* -:hi[ghlight] clear Reset all highlighting to the defaults. Removes all +:hi[ghlight] clear *highlight-clear* *:hi-clear* + Reset all highlighting to the defaults. Removes all highlighting for groups added by the user. Uses the current value of 'background' to decide which default colors to use. @@ -5557,18 +5557,18 @@ scrollbars and tooltips. They don't have defaults. This doesn't work for the Win32 GUI. Only three highlight arguments have any effect here: font, guibg, and guifg. - *hl-Menu* -Menu Current font, background and foreground colors of the menus. +Menu *hl-Menu* + Current font, background and foreground colors of the menus. Also used for the toolbar. Applicable highlight arguments: font, guibg, guifg. - *hl-Scrollbar* -Scrollbar Current background and foreground of the main window's +Scrollbar *hl-Scrollbar* + Current background and foreground of the main window's scrollbars. Applicable highlight arguments: guibg, guifg. - *hl-Tooltip* -Tooltip Current font, background and foreground of the tooltips. +Tooltip *hl-Tooltip* + Current font, background and foreground of the tooltips. Applicable highlight arguments: font, guibg, guifg. ============================================================================== |