neovim

commit 3cce6570312830dfab9efd9d521125f0049ad55f
parent 4f42b69b4ad0d0034581d756ef9bcb0e55f3491d
Author: Justin M. Keyes <justinkz@gmail.com>
Date:   Wed, 26 Feb 2025 15:00:54 -0800

refactor: old references to scripts/ dir #32647


Diffstat:
M
src/gen/gen_help_html.lua
 | 
19
+++++++++----------

1 file changed, 9 insertions(+), 10 deletions(-)
diff --git a/src/gen/gen_help_html.lua b/src/gen/gen_help_html.lua
@@ -1,24 +1,23 @@
 --- Converts Nvim :help files to HTML.  Validates |tag| links and document syntax (parser errors).
 --
--- USAGE (For CI/local testing purposes): Simply `make lintdoc` or `scripts/lintdoc.lua`, which
--- basically does the following:
+-- USAGE (For CI/local testing purposes): Simply `make lintdoc`, which basically does the following:
 --   1. :helptags ALL
---   2. nvim -V1 -es +"lua require('scripts.gen_help_html').run_validate()" +q
---   3. nvim -V1 -es +"lua require('scripts.gen_help_html').test_gen()" +q
+--   2. nvim -V1 -es +"lua require('src.gen.gen_help_html').run_validate()" +q
+--   3. nvim -V1 -es +"lua require('src.gen.gen_help_html').test_gen()" +q
 --
 -- USAGE (GENERATE HTML):
 --   1. `:helptags ALL` first; this script depends on vim.fn.taglist().
---   2. nvim -V1 -es --clean +"lua require('scripts.gen_help_html').gen('./runtime/doc', 'target/dir/')" +q
+--   2. nvim -V1 -es --clean +"lua require('src.gen.gen_help_html').gen('./runtime/doc', 'target/dir/')" +q
 --      - Read the docstring at gen().
 --   3. cd target/dir/ && jekyll serve --host 0.0.0.0
 --   4. Visit http://localhost:4000/…/help.txt.html
 --
 -- USAGE (VALIDATE):
---   1. nvim -V1 -es +"lua require('scripts.gen_help_html').validate('./runtime/doc')" +q
+--   1. nvim -V1 -es +"lua require('src.gen.gen_help_html').validate('./runtime/doc')" +q
 --      - validate() is 10x faster than gen(), so it is used in CI.
 --
 -- SELF-TEST MODE:
---   1. nvim -V1 -es +"lua require('scripts.gen_help_html')._test()" +q
+--   1. nvim -V1 -es +"lua require('src.gen.gen_help_html')._test()" +q
 --
 -- NOTES:
 --   * This script is used by the automation repo: https://github.com/neovim/doc
@@ -277,7 +276,7 @@ end
 
 --- Removes the common indent level, after expanding tabs to 8 spaces.
 local function trim_indent(s)
-  return vim.text.indent(0, s, { expandtab = 8 })
+  return (vim.text.indent(0, s, { expandtab = 8 }))
 end
 
 --- Gets raw buffer text in the node's range (+/- an offset), as a newline-delimited string.
@@ -935,7 +934,7 @@ local function gen_one(fname, text, to_fname, old, commit, parser_path)
   <a name="%s" href="#%s"><h1 id="%s">%s</h1></a>
   <p>
     <i>
-    Nvim <code>:help</code> pages, <a href="https://github.com/neovim/neovim/blob/master/scripts/gen_help_html.lua">generated</a>
+    Nvim <code>:help</code> pages, <a href="https://github.com/neovim/neovim/blob/master/src/gen/gen_help_html.lua">generated</a>
     from <a href="https://github.com/neovim/neovim/blob/master/runtime/doc/%s">source</a>
     using the <a href="https://github.com/neovim/tree-sitter-vimdoc">tree-sitter-vimdoc</a> parser.
     </i>
@@ -1449,7 +1448,7 @@ function M.run_validate(help_dir)
   eq(
     {},
     rv.invalid_spelling,
-    'invalid spelling in :help docs (see spell_dict in scripts/gen_help_html.lua)'
+    'invalid spelling in :help docs (see spell_dict in src/gen/gen_help_html.lua)'
   )
 end