aboutsummaryrefslogtreecommitdiff
path: root/scripts/gen_vimdoc.py
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2022-10-14 11:01:13 -0400
committerGitHub <noreply@github.com>2022-10-14 08:01:13 -0700
commite5cb3104d07228de4f2614c425355e8f2f99507d (patch)
tree919827f5a8665874a166a6a6a3c5540e7d087c3a /scripts/gen_vimdoc.py
parent0a19c1677877843d50cea6dec150acde50df356c (diff)
downloadrneovim-e5cb3104d07228de4f2614c425355e8f2f99507d.tar.gz
rneovim-e5cb3104d07228de4f2614c425355e8f2f99507d.tar.bz2
rneovim-e5cb3104d07228de4f2614c425355e8f2f99507d.zip
docs: fix/remove invalid URLs #20647
Diffstat (limited to 'scripts/gen_vimdoc.py')
-rwxr-xr-xscripts/gen_vimdoc.py11
1 files changed, 3 insertions, 8 deletions
diff --git a/scripts/gen_vimdoc.py b/scripts/gen_vimdoc.py
index 3ee9d8b5dd..a044c8c39d 100755
--- a/scripts/gen_vimdoc.py
+++ b/scripts/gen_vimdoc.py
@@ -12,15 +12,10 @@ Flow:
update_params_map /
render_node
-This would be easier using lxml and XSLT, but:
+TODO: eliminate this script and use Lua+treesitter (requires parsers for C and
+Lua markdown-style docstrings).
- 1. This should avoid needing Python dependencies, especially ones that are
- C modules that have library dependencies (lxml requires libxml and
- libxslt).
- 2. I wouldn't know how to deal with nested indentation in <para> tags using
- XSLT.
-
-Each function :help block is formatted as follows:
+The generated :help text for each function is formatted as follows:
- Max width of 78 columns (`text_width`).
- Indent with spaces (not tabs).