summaryrefslogtreecommitdiffstats
path: root/scripts
diff options
context:
space:
mode:
authorJon Heinritz <jon.heinritz@protonmail.com>2024-05-22 01:24:14 +0200
committerGitHub <noreply@github.com>2024-05-21 16:24:14 -0700
commitb8f3ed3903430033f638b17f7455b8fd3d6a85b5 (patch)
tree41806a1c4e413eae93c8eb8953cad2d4f9074c9c /scripts
parent00f9d91391b04b1935e2f15948bd96cc111e7d3a (diff)
docs: better type definitions for top-level functions (#410)
* docs: extract conform.format(opts) into it's own class * docs: extract conform.format_lines(opts) into it's own class * refactor: use new nvim_doc_tools capability to remove duplicated class definition --------- Co-authored-by: Steven Arcangeli <stevearc@stevearc.com>
Diffstat (limited to 'scripts')
-rwxr-xr-xscripts/generate.py18
1 files changed, 11 insertions, 7 deletions
diff --git a/scripts/generate.py b/scripts/generate.py
index e671ce0..30c3b12 100755
--- a/scripts/generate.py
+++ b/scripts/generate.py
@@ -11,11 +11,11 @@ from nvim_doc_tools import (
dedent,
generate_md_toc,
indent,
- parse_functions,
+ parse_directory,
read_nvim_json,
read_section,
- render_md_api,
- render_vimdoc_api,
+ render_md_api2,
+ render_vimdoc_api2,
replace_section,
wrap,
)
@@ -122,8 +122,9 @@ def add_md_link_path(path: str, lines: List[str]) -> List[str]:
def update_md_api():
- funcs = parse_functions(os.path.join(ROOT, "lua", "conform", "init.lua"))
- lines = ["\n"] + render_md_api(funcs, 3)[:-1] # trim last newline
+ types = parse_directory(os.path.join(ROOT, "lua"))
+ funcs = types.files["conform/init.lua"].functions
+ lines = ["\n"] + render_md_api2(funcs, types, 3)[:-1] # trim last newline
replace_section(
README,
r"^<!-- API -->$",
@@ -186,11 +187,14 @@ def gen_formatter_vimdoc() -> VimdocSection:
def generate_vimdoc():
doc = Vimdoc("conform.txt", "conform")
- funcs = parse_functions(os.path.join(ROOT, "lua", "conform", "init.lua"))
+ types = parse_directory(os.path.join(ROOT, "lua"))
+ funcs = types.files["conform/init.lua"].functions
doc.sections.extend(
[
gen_options_vimdoc(),
- VimdocSection("API", "conform-api", render_vimdoc_api("conform", funcs)),
+ VimdocSection(
+ "API", "conform-api", render_vimdoc_api2("conform", funcs, types)
+ ),
gen_formatter_vimdoc(),
]
)