fix(doc): use canonical function tags for vim.keymap.set() and nvim_create_autocmd() #340

Merged

barrettruth merged 1 commit from fix/vimdoc-function-tags into main

2026-05-01 03:47:30 +00:00

barrettruth commented

2026-05-01 03:46:11 +00:00

Owner

Two help-tag references in doc/oil.txt resolved to external nvim core tags that vimdoc-language-server's runtime-tag loader couldn't find:

doc/oil.txt:711:99 — |vim.keymap.set| → |vim.keymap.set()|
doc/oil.txt:1451:1 — |nvim_create_autocmd| → |nvim_create_autocmd()|

nvim's runtime help ($VIMRUNTIME/doc/tags) defines these tags with parentheses per the vim help convention for functions: vim.keymap.set() in lua.txt and nvim_create_autocmd() in api.txt. The oil.txt references were written without parens so the loader could never match them.

Adding the parens makes the references canonical — they now resolve correctly both via vimdoc-language-server check and when a user navigates with :help or K in a help buffer. No behavior change beyond the help-link resolving.

Unblocks forgejo CI Lint on main (red since migration commit e3c6cc8).

Two help-tag references in `doc/oil.txt` resolved to external nvim core tags that vimdoc-language-server's runtime-tag loader couldn't find: - `doc/oil.txt:711:99` — `|vim.keymap.set|` → `|vim.keymap.set()|` - `doc/oil.txt:1451:1` — `|nvim_create_autocmd|` → `|nvim_create_autocmd()|` nvim's runtime help (`$VIMRUNTIME/doc/tags`) defines these tags with parentheses per the vim help convention for functions: `vim.keymap.set()` in `lua.txt` and `nvim_create_autocmd()` in `api.txt`. The oil.txt references were written without parens so the loader could never match them. Adding the parens makes the references canonical — they now resolve correctly both via `vimdoc-language-server check` and when a user navigates with `:help` or `K` in a help buffer. No behavior change beyond the help-link resolving. Unblocks forgejo CI `Lint` on `main` (red since migration commit `e3c6cc8`).

barrettruth added 1 commit

2026-05-01 03:46:11 +00:00

fix(doc): use canonical function tags for vim.keymap.set() and nvim_create_autocmd()

quality / Lint (pull_request) Successful in 6s

Details

quality / Test (pull_request) Successful in 7s

Details

quality / Format (pull_request) Successful in 9s

Details

9f61ec8e86

Two help-tag references in oil.txt resolved to external nvim core tags that
vimdoc-language-server's runtime-tag loader couldn't find:

  doc/oil.txt:711:99  |vim.keymap.set|       -> |vim.keymap.set()|
  doc/oil.txt:1451:1  |nvim_create_autocmd|  -> |nvim_create_autocmd()|

nvim's runtime help ($VIMRUNTIME/doc/tags) defines these tags with
parentheses per the vim help convention for functions: `vim.keymap.set()`
in lua.txt and `nvim_create_autocmd()` in api.txt. The oil.txt references
were written without parens so the loader could never match them.

Adding the parens makes the references canonical — they now resolve to
the correct tags both via vimdoc-language-server's check command and when
a user navigates with `:help` or K in a help buffer. No behavior change
beyond the help-link resolving correctly.

Unblocks forgejo CI Lint on main (red since migration commit e3c6cc8).

barrettruth merged commit b493e716ec into main

2026-05-01 03:47:30 +00:00

barrettruth referenced this pull request from a commit

2026-05-01 03:47:32 +00:00

fix(doc): use canonical function tags for vim.keymap.set() and nvim_create_autocmd() (#340)