mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-10-26 12:27:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(builtin): show tag at first line with multiple signatures (#27577)

Browse Source 
Problem:
When a function has multiple signatures, putting its tag at the last one
may make one think that's its only signature.

Solution:
When a function has multiple signatures, put its tag at the first one.
This commit is contained in:
zeertzjq
2024-02-22 19:39:58 +08:00
committed by GitHub
parent 42f8ada59d
commit 741a6684e0
2 changed files with 23 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
scripts/gen_eval_files.lua
View File

@@ -411,9 +411,6 @@ local function render_eval_meta(f, fun, write)
write(render_fun_sig(funname, params))
end
--- @type table<string,true>
local rendered_tags = {}
--- @param name string
--- @param fun vim.EvalFn
--- @param write fun(line: string)
@@ -455,24 +452,17 @@ local function render_eval_doc(f, fun, write)
return
end
local desc = fun.desc
if not desc then
if f:find('__%d+$') then
write(fun.signature)
else
render_sig_and_tag(fun.name or f, fun, write)
end
if not fun.desc then
return
end
local name = fun.name or f
if rendered_tags[name] then
write(fun.signature)
else
render_sig_and_tag(name, fun, write)
rendered_tags[name] = true
end
desc = vim.trim(desc)
local desc_l = split(desc)
local desc_l = split(vim.trim(fun.desc))
for _, l in ipairs(desc_l) do
l = l:gsub('^ ', '')
if vim.startswith(l, '<') and not l:match('^<[^ \t]+>') then