rneovim.git/test/functional/lua/help_spec.lua, branch rahm

build(docs): separate lint job to validate vimdoc #27227

2024-01-28T22:22:39+00:00

Summary: Separate the lint job (`make lintdoc`) to validate runtime/doc,
it is no longer as a part of functionaltest (help_spec).

Build (cmake) and CI:

- `make lintdoc`: validate vimdoc files and test-generate HTML docs.
  CI will run this as a part of the "docs" workflow.

- `scripts/lintdoc.lua` is added as an entry point (executable script)
  for validating vimdoc files.

scripts/gen_help_html.lua:

- Move the tests for validating docs and generating HTMLs from
  `help_spec.lua` to `gen_help_html`. Added:
  - `gen_help_html.run_validate()`.
  - `gen_help_html.test_gen()`.

- Do not hard-code `help_dir` to `build/runtime/doc`, but resolve from
  `$VIMRUNTIME`. Therefore, the `make lintdoc` job will check doc files
  on `./runtime/doc`, not on `./build/runtime/doc`.

- Add type annotations for gen_help_html.

refactor: format test/*

2024-01-03T01:09:29+00:00

ci(cirrus): don't run lua/help_spec (#25498)

2023-10-20T23:21:19+00:00

fix(docs): vimdoc syntax errors

2023-06-25T15:14:28+00:00

gen_help_html: truncate parse-error sample text

test: spellcheck :help (vimdoc) files #24109

2023-06-22T10:44:51+00:00

Enforce consistent terminology (defined in
`gen_help_html.lua:spell_dict`) for common misspellings.

This does not spellcheck English in general (perhaps a future TODO,
though it may be noisy).

test(help): drop treesitter parse error to 0

2023-02-23T09:24:15+00:00

All parser errors have been fixed; make sure we don't introduce new
ones.

docs: update vimdoc parser #20747

2022-10-20T13:20:02+00:00

Remove the user-manual ToC from help.txt, because:
1. it duplicates usr_toc.txt
2. it is not what most readers are looking for in the main help page.

fix https://github.com/neovim/tree-sitter-vimdoc/issues/49
fix https://github.com/neovim/tree-sitter-vimdoc/issues/50
fix https://github.com/neovim/tree-sitter-vimdoc/issues/51

feat(docs): update parser, HTML gen #20720

2022-10-18T14:18:44+00:00

Note: although the tolerance in help_spec.lua increased, the actual
error count with the new parser decreased by about 20%. The difference
is that the old ignore_parse_error() ignored many more errors with the
old parser.

fix https://github.com/neovim/tree-sitter-vimdoc/issues/37
fix https://github.com/neovim/tree-sitter-vimdoc/issues/44
fix https://github.com/neovim/tree-sitter-vimdoc/issues/47

build(deps): bump vimdoc (help) parser to v1.2.1 #20642

2022-10-14T01:36:25+00:00

fix(docs-html): keycodes, taglinks, column_heading #20498

2022-10-06T13:16:00+00:00

Problem:
- Docs HTML: "foo ~" headings (column_heading) are not aligned with
  their table columns/contents because the leading whitespace is not
  emitted.
- taglinks starting with hyphen like |-x| were not recognized.
- keycodes like `` and `CTRL-x` were not recognized.
- ToC is not scrollable.

Solution:
- Add ws() to the column_heading case.
- Update help parser to latest version
  - supports `keycode`
  - fixes for taglink, argument
- Update .toc CSS. https://github.com/neovim/neovim.github.io/issues/297

fix https://github.com/neovim/neovim.github.io/issues/297