IntenseFinance/neovim
3
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-02-25 18:55:25 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs(builtin): right align tags (#24522)

Browse Source
This commit is contained in:
Lewis Russell 2023-08-01 11:12:00 +01:00 committed by GitHub
parent ccb5a76e5a
commit 20bfdbe832
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 461 additions and 450 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

868
runtime/doc/builtin.txt generated
View File

File diff suppressed because it is too large Load Diff

43
scripts/gen_eval_files.lua
View File

@ -113,6 +113,31 @@ end
--- @type table<string,true> --- @type table<string,true>
local rendered_tags = {} local rendered_tags = {}
--- @param name string
--- @param fun vim.EvalFn
--- @param write fun(line: string)
local function render_sig_and_tag(name, fun, write)
local tags = { '*' .. name .. '()*' }
if fun.tags then
for _, t in ipairs(fun.tags) do
tags[#tags + 1] = '*' .. t .. '*'
end
end
local tag = table.concat(tags, ' ')
local siglen = #fun.signature
local conceal_offset = 2*(#tags - 1)
local tag_pad_len = math.max(1, 80 - #tag + conceal_offset)
if siglen + #tag > 80 then
write(string.rep(' ', tag_pad_len) .. tag)
write(fun.signature)
else
write(string.format('%s%s%s', fun.signature, string.rep(' ', tag_pad_len - siglen), tag))
end
end
--- @param f string --- @param f string
--- @param fun vim.EvalFn --- @param fun vim.EvalFn
--- @param write fun(line: string) --- @param write fun(line: string)
@ -133,27 +158,13 @@ local function render_eval_doc(f, fun, write)
end end
local name = fun.name or f local name = fun.name or f
local tags = { '*' .. name .. '()*' }
if fun.tags then
for _, t in ipairs(fun.tags) do
tags[#tags + 1] = '*' .. t .. '*'
end
end
local tag = table.concat(tags, ' ')
local siglen = #fun.signature
if rendered_tags[name] then if rendered_tags[name] then
write(fun.signature) write(fun.signature)
else else
if siglen + #tag > 80 then render_sig_and_tag(name, fun, write)
write(string.rep('\t', 6) .. tag) rendered_tags[name] = true
write(fun.signature)
else
local tt = math.max(1, (76 - siglen - #tag) / 8)
write(string.format('%s%s%s', fun.signature, string.rep('\t', tt), tag))
end
end end
rendered_tags[name] = true
desc = vim.trim(desc) desc = vim.trim(desc)
local desc_l = vim.split(desc, '\n', { plain = true }) local desc_l = vim.split(desc, '\n', { plain = true })