mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-09-06 03:18:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(lsp): fix type annotation on convert_input_to_markdown_lines (#21772)

Browse Source 
This small changes just ensures that if you're using `convert_input_to_markdown_lines`
without `contents` you don't get a warning (when using something like neodev) that
there is an expected second param, since it can be nil.
This commit is contained in:
Chris Kipp
2023-01-12 15:51:19 +01:00
committed by GitHub
parent a5f4ba7447
commit 443bbfd59e
2 changed files with 3 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
runtime/doc/lsp.txt
View File

@@ -1508,8 +1508,8 @@ convert_input_to_markdown_lines({input}, {contents})
Parameters: ~ Parameters: ~
• {input} (`MarkedString` | `MarkedString[]` | `MarkupContent`) • {input} (`MarkedString` | `MarkedString[]` | `MarkupContent`)
• {contents} (table, optional, default `{}`) List of strings to extend • {contents} (table|nil) List of strings to extend with converted
with converted lines lines. Defaults to {}.
Return: ~ Return: ~
{contents}, extended with lines of converted markdown. {contents}, extended with lines of converted markdown.

2
runtime/lua/vim/lsp/util.lua
View File

@@ -856,7 +856,7 @@ end
--- `textDocument/signatureHelp`, and potentially others. --- `textDocument/signatureHelp`, and potentially others.
--- ---
---@param input (`MarkedString` | `MarkedString[]` | `MarkupContent`) ---@param input (`MarkedString` | `MarkedString[]` | `MarkupContent`)
---@param contents (table, optional, default `{}`) List of strings to extend with converted lines ---@param contents (table|nil) List of strings to extend with converted lines. Defaults to {}.
---@returns {contents}, extended with lines of converted markdown. ---@returns {contents}, extended with lines of converted markdown.
---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_hover ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_hover
function M.convert_input_to_markdown_lines(input, contents) function M.convert_input_to_markdown_lines(input, contents)