diff options
author | Chris Kipp <ckipp@pm.me> | 2023-01-12 15:51:19 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-01-12 15:51:19 +0100 |
commit | 443bbfd59e2818aeee72d2ed77af1cb24617e46f (patch) | |
tree | d89c963812603af67347f91def65e819e0d659f5 | |
parent | a5f4ba74472f965953f0d3e45704c93b95f9b9a7 (diff) | |
download | rneovim-443bbfd59e2818aeee72d2ed77af1cb24617e46f.tar.gz rneovim-443bbfd59e2818aeee72d2ed77af1cb24617e46f.tar.bz2 rneovim-443bbfd59e2818aeee72d2ed77af1cb24617e46f.zip |
docs(lsp): fix type annotation on convert_input_to_markdown_lines (#21772)
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.
-rw-r--r-- | runtime/doc/lsp.txt | 4 | ||||
-rw-r--r-- | runtime/lua/vim/lsp/util.lua | 2 |
2 files changed, 3 insertions, 3 deletions
diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt index 703c0b9d03..46cfa60529 100644 --- a/runtime/doc/lsp.txt +++ b/runtime/doc/lsp.txt @@ -1508,8 +1508,8 @@ convert_input_to_markdown_lines({input}, {contents}) Parameters: ~ • {input} (`MarkedString` | `MarkedString[]` | `MarkupContent`) - • {contents} (table, optional, default `{}`) List of strings to extend - with converted lines + • {contents} (table|nil) List of strings to extend with converted + lines. Defaults to {}. Return: ~ {contents}, extended with lines of converted markdown. diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua index 26f0e180f5..38051e6410 100644 --- a/runtime/lua/vim/lsp/util.lua +++ b/runtime/lua/vim/lsp/util.lua @@ -856,7 +856,7 @@ end --- `textDocument/signatureHelp`, and potentially others. --- ---@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. ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_hover function M.convert_input_to_markdown_lines(input, contents) |