diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2025-03-09 10:27:28 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-03-09 10:27:28 -0700 |
| commit | 34a2bfdcc5ce03a1c8e2128cd1c3e7ab99755d12 (patch) | |
| tree | 70d05aff44f288fe46121c83431137b58cd7d9b5 /runtime/doc/develop.txt | |
| parent | 903242f160faff5f7e3b9ae1a5273ac75a55ed6b (diff) | |
| download | rneovim-34a2bfdcc5ce03a1c8e2128cd1c3e7ab99755d12.tar.gz rneovim-34a2bfdcc5ce03a1c8e2128cd1c3e7ab99755d12.tar.bz2 rneovim-34a2bfdcc5ce03a1c8e2128cd1c3e7ab99755d12.zip | |
fix(build): vimdoc tags are not validated #32801
Problem:
"make lintdoc" is not validating vimdoc (:help) tags.
Solution:
- Call `lang_tree:parse()` to init the parser.
- Load netrw 🤢 explicitly, since it was moved to `pack/dist/opt/`.
- Fix invalid help tags.
Diffstat (limited to 'runtime/doc/develop.txt')
| -rw-r--r-- | runtime/doc/develop.txt | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/runtime/doc/develop.txt b/runtime/doc/develop.txt index d3170f114f..8d60d2c868 100644 --- a/runtime/doc/develop.txt +++ b/runtime/doc/develop.txt @@ -376,10 +376,10 @@ Where possible, these patterns apply to _both_ Lua and the API: - See |vim.lsp.inlay_hint.enable()| and |vim.lsp.inlay_hint.is_enabled()| for a reference implementation of these "best practices". - NOTE: open questions: https://github.com/neovim/neovim/issues/28603 -- Transformation functions should also have a filter functionality when - appropriate. That is, when the function returns a nil value it "filters" its - input, otherwise the transformed value is used. - - Example: |vim.diagnostic.config.format()| +- Transformation functions should also have "filter" functionality (when + appropriate): when the function returns a nil value it excludes (filters + out) its input, else the transformed value is used. + - Example: See the format() field of |vim.diagnostic.Opts.Float|. API DESIGN GUIDELINES *dev-api* |