diff options
author | zeertzjq <zeertzjq@outlook.com> | 2023-11-28 13:52:17 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-11-28 13:52:17 +0800 |
commit | 570367ac83cdceeee7d43dadcff7652bd5cc93c5 (patch) | |
tree | 6318631c6f22fb597e4bd706e0f58f2328f69e37 /scripts/gen_eval_files.lua | |
parent | e6d38c7dac2e079d9b0f1621fef193bca858664f (diff) | |
download | rneovim-570367ac83cdceeee7d43dadcff7652bd5cc93c5.tar.gz rneovim-570367ac83cdceeee7d43dadcff7652bd5cc93c5.tar.bz2 rneovim-570367ac83cdceeee7d43dadcff7652bd5cc93c5.zip |
docs(lua): don't include remote-only API functions (#26266)
Diffstat (limited to 'scripts/gen_eval_files.lua')
-rwxr-xr-x | scripts/gen_eval_files.lua | 50 |
1 files changed, 26 insertions, 24 deletions
diff --git a/scripts/gen_eval_files.lua b/scripts/gen_eval_files.lua index 714358e488..e331dd996e 100755 --- a/scripts/gen_eval_files.lua +++ b/scripts/gen_eval_files.lua @@ -178,34 +178,36 @@ local function get_api_meta() local doc_metadata = vim.mpack.decode(doc_mpack_f:read('*all')) --[[@as table<string,vim.gen_vim_doc_fun>]] for _, fun in ipairs(metadata) do - local fdoc = doc_metadata[fun.name] - - local params = {} --- @type {[1]:string,[2]:string}[] - for _, p in ipairs(fun.parameters) do - local ptype, pname = p[1], p[2] - params[#params + 1] = { - pname, - api_type(ptype), - fdoc and fdoc.parameters_doc[pname] or nil, - } - end + if fun.lua then + local fdoc = doc_metadata[fun.name] + + local params = {} --- @type {[1]:string,[2]:string}[] + for _, p in ipairs(fun.parameters) do + local ptype, pname = p[1], p[2] + params[#params + 1] = { + pname, + api_type(ptype), + fdoc and fdoc.parameters_doc[pname] or nil, + } + end - local r = { - signature = 'NA', - name = fun.name, - params = params, - returns = api_type(fun.return_type), - deprecated = fun.deprecated_since ~= nil, - } + local r = { + signature = 'NA', + name = fun.name, + params = params, + returns = api_type(fun.return_type), + deprecated = fun.deprecated_since ~= nil, + } - if fdoc then - if #fdoc.doc > 0 then - r.desc = table.concat(fdoc.doc, '\n') + if fdoc then + if #fdoc.doc > 0 then + r.desc = table.concat(fdoc.doc, '\n') + end + r.return_desc = (fdoc['return'] or {})[1] end - r.return_desc = (fdoc['return'] or {})[1] - end - ret[fun.name] = r + ret[fun.name] = r + end end return ret end |