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/gui.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/gui.txt')
| -rw-r--r-- | runtime/doc/gui.txt | 12 |
1 files changed, 4 insertions, 8 deletions
diff --git a/runtime/doc/gui.txt b/runtime/doc/gui.txt index 80d0dfdad7..399b33156c 100644 --- a/runtime/doc/gui.txt +++ b/runtime/doc/gui.txt @@ -96,8 +96,7 @@ Stop or detach the current UI ------------------------------------------------------------------------------ Restart Nvim - *:restart* *:restart!* *E5201* -:restart[!] [+cmd] [command] +:restart[!] [+cmd] [command] *:restart* *:restart!* *E5201* Restarts Nvim. Saves and restores the current session, unless [!] is given. Sets |v:exitreason|. See also |ZR|. @@ -127,8 +126,7 @@ Restart Nvim ------------------------------------------------------------------------------ Connect UI to a different server - *:connect* -:connect {address} +:connect {address} *:connect* Attaches the UI to another Nvim instance: detaches from the current server, then attaches to {address}. @@ -142,8 +140,7 @@ Connect UI to a different server ------------------------------------------------------------------------------ GUI commands - *:winp* *:winpos* *E188* -:winp[os] +:winp[os] *:winp* *:winpos* *E188* Display current position of the top left corner of the GUI vim window in pixels. Does not work in all versions. Also see |getwinpos()|, |getwinposx()| and |getwinposy()|. @@ -156,8 +153,7 @@ GUI commands remembered until the window is opened. The position is adjusted to make the window fit on the screen (if possible). - *:wi* *:win* *:winsize* *E465* -:win[size] {width} {height} +:win[size] {width} {height} *:wi* *:win* *:winsize* *E465* Set the window height to {width} by {height} characters. Obsolete, use ":set lines=11 columns=22". |