diff options
| author | Gregory Anders <greg@gpanders.com> | 2021-11-29 22:11:33 -0700 |
|---|---|---|
| committer | Dundar Göc <gocdundar@gmail.com> | 2021-11-30 09:03:41 +0100 |
| commit | 5a24c2c83d76432e38f40d31db4c0a8fdd4232cf (patch) | |
| tree | bf26f1670268095e0098c1f50ec8f0f8daa9fe44 | |
| parent | b6e531c1d90da143d4351442baee8fef0479a6f7 (diff) | |
| download | rneovim-5a24c2c83d76432e38f40d31db4c0a8fdd4232cf.tar.gz rneovim-5a24c2c83d76432e38f40d31db4c0a8fdd4232cf.tar.bz2 rneovim-5a24c2c83d76432e38f40d31db4c0a8fdd4232cf.zip | |
docs(lsp): do not use | as argument separator
This translates into a tag in the help doc.
| -rw-r--r-- | runtime/doc/lsp.txt | 12 | ||||
| -rw-r--r-- | runtime/lua/vim/lsp/util.lua | 8 |
2 files changed, 10 insertions, 10 deletions
diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt index c829fac566..a9669e9e01 100644 --- a/runtime/doc/lsp.txt +++ b/runtime/doc/lsp.txt @@ -1347,18 +1347,18 @@ buf_clear_references({bufnr}) *vim.lsp.util.buf_clear_references()* Removes document highlights from a buffer. Parameters: ~ - {bufnr} buffer id + {bufnr} number Buffer id *vim.lsp.util.buf_highlight_references()* buf_highlight_references({bufnr}, {references}, {offset_encoding}) Shows a list of document highlights for a certain buffer. Parameters: ~ - {bufnr} buffer id - {references} List of `DocumentHighlight` objects to - highlight - {offset_encoding} string utf-8|utf-16|utf-32|nil defaults - to utf-16 + {bufnr} number Buffer id + {references} table List of `DocumentHighlight` + objects to highlight + {offset_encoding} string One of "utf-8", "utf-16", + "utf-32", or nil. Defaults to utf-16 See also: ~ https://microsoft.github.io/language-server-protocol/specifications/specification-3-17/#documentHighlight diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua index e9155a7231..950611a074 100644 --- a/runtime/lua/vim/lsp/util.lua +++ b/runtime/lua/vim/lsp/util.lua @@ -1416,7 +1416,7 @@ do --[[ References ]] --- Removes document highlights from a buffer. --- - ---@param bufnr buffer id + ---@param bufnr number Buffer id function M.buf_clear_references(bufnr) validate { bufnr = {bufnr, 'n', true} } api.nvim_buf_clear_namespace(bufnr, reference_ns, 0, -1) @@ -1424,9 +1424,9 @@ do --[[ References ]] --- Shows a list of document highlights for a certain buffer. --- - ---@param bufnr buffer id - ---@param references List of `DocumentHighlight` objects to highlight - ---@param offset_encoding string utf-8|utf-16|utf-32|nil defaults to utf-16 + ---@param bufnr number Buffer id + ---@param references table List of `DocumentHighlight` objects to highlight + ---@param offset_encoding string One of "utf-8", "utf-16", "utf-32", or nil. Defaults to utf-16 ---@see https://microsoft.github.io/language-server-protocol/specifications/specification-3-17/#documentHighlight function M.buf_highlight_references(bufnr, references, offset_encoding) validate { bufnr = {bufnr, 'n', true} } |