feat(lsp): document method types (#35934)

This commit is contained in:
Maria Solano
2025-09-27 14:52:30 -07:00
committed by GitHub
parent 5fbc5ab810
commit c5c6ddba91
3 changed files with 8 additions and 1 deletions

View File

@@ -154,6 +154,7 @@ local function write_to_vim_protocol(protocol)
{ title = 'Request', methods = protocol.requests },
{ title = 'Notification', methods = protocol.notifications },
}) do
output[#output + 1] = ('--- LSP %s (direction: %s)'):format(b.title, dir)
output[#output + 1] = ('--- @alias %s.%s'):format(alias, b.title)
for _, item in ipairs(b.methods) do
if item.messageDirection == dir then
@@ -164,6 +165,7 @@ local function write_to_vim_protocol(protocol)
end
vim.list_extend(output, {
('--- LSP Message (direction: %s).'):format(dir),
('--- @alias %s'):format(alias),
('--- | %s.Request'):format(alias),
('--- | %s.Notification'):format(alias),

View File

@@ -465,7 +465,6 @@ end
--- @param generics? table<string,string>
--- @param default? string
local function render_type(ty, generics, default)
-- TODO(lewis6991): Document LSP protocol types
ty = ty:gsub('vim%.lsp%.protocol%.Method.[%w.]+', 'string')
if generics then