From 34a2bfdcc5ce03a1c8e2128cd1c3e7ab99755d12 Mon Sep 17 00:00:00 2001 From: "Justin M. Keyes" Date: Sun, 9 Mar 2025 10:27:28 -0700 Subject: fix(build): vimdoc tags are not validated #32801 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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. --- runtime/doc/develop.txt | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) (limited to 'runtime/doc/develop.txt') 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* -- cgit