aboutsummaryrefslogtreecommitdiff
path: root/scripts/gen_vimdoc.lua
diff options
context:
space:
mode:
authorLewis Russell <lewis6991@gmail.com>2024-03-05 12:06:15 +0000
committerLewis Russell <me@lewisr.dev>2024-03-05 13:36:46 +0000
commita4290f462ed7dc81e17b09bd27877b106b24b6bd (patch)
treeab880e80f92fe337ff4581eba2454bb4b882375a /scripts/gen_vimdoc.lua
parent5b312cd5f67646005312d2ebb2ef0d1bc584dcff (diff)
downloadrneovim-a4290f462ed7dc81e17b09bd27877b106b24b6bd.tar.gz
rneovim-a4290f462ed7dc81e17b09bd27877b106b24b6bd.tar.bz2
rneovim-a4290f462ed7dc81e17b09bd27877b106b24b6bd.zip
docs(lua): improvements for LSP and Diagnostic
Diffstat (limited to 'scripts/gen_vimdoc.lua')
-rwxr-xr-xscripts/gen_vimdoc.lua15
1 files changed, 8 insertions, 7 deletions
diff --git a/scripts/gen_vimdoc.lua b/scripts/gen_vimdoc.lua
index 8e2ff8193c..22df411a35 100755
--- a/scripts/gen_vimdoc.lua
+++ b/scripts/gen_vimdoc.lua
@@ -536,7 +536,8 @@ local function render_fields_or_params(xs, generics, classes, exclude_types)
end
--- @param class nvim.luacats.parser.class
-local function render_class(class)
+--- @param classes table<string,nvim.luacats.parser.class>
+local function render_class(class, classes)
if class.access or class.nodoc or class.inlinedoc then
return
end
@@ -548,13 +549,14 @@ local function render_class(class)
if class.parent then
local txt = fmt('Extends: |%s|', class.parent)
table.insert(ret, md_to_vimdoc(txt, INDENTATION, INDENTATION, TEXT_WIDTH))
+ table.insert(ret, '\n')
end
if class.desc then
table.insert(ret, md_to_vimdoc(class.desc, INDENTATION, INDENTATION, TEXT_WIDTH))
end
- local fields_txt = render_fields_or_params(class.fields)
+ local fields_txt = render_fields_or_params(class.fields, nil, classes)
if not fields_txt:match('^%s*$') then
table.insert(ret, '\n Fields: ~\n')
table.insert(ret, fields_txt)
@@ -564,13 +566,12 @@ local function render_class(class)
return table.concat(ret)
end
---- @param cls table<string,nvim.luacats.parser.class>
-local function render_classes(cls)
+--- @param classes table<string,nvim.luacats.parser.class>
+local function render_classes(classes)
local ret = {} --- @type string[]
- --- @diagnostic disable-next-line:no-unknown
- for _, class in vim.spairs(cls) do
- ret[#ret + 1] = render_class(class)
+ for _, class in vim.spairs(classes) do
+ ret[#ret + 1] = render_class(class, classes)
end
return table.concat(ret)