diff options
| author | Chris Kipp <ckipp@pm.me> | 2021-02-24 17:23:47 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-02-24 17:23:47 +0100 |
| commit | 7d82aaa6f5a6403f3c4e330dcaba9bb36ecbef28 (patch) | |
| tree | 2008cb3fe6784d12fc003b79224e55ff164e0ba9 /runtime/lua/vim/lsp/buf.lua | |
| parent | d290da70b76a2dcd99591ec1a175a4ae29f64bfd (diff) | |
| download | rneovim-7d82aaa6f5a6403f3c4e330dcaba9bb36ecbef28.tar.gz rneovim-7d82aaa6f5a6403f3c4e330dcaba9bb36ecbef28.tar.bz2 rneovim-7d82aaa6f5a6403f3c4e330dcaba9bb36ecbef28.zip | |
[LSP] Add in more docs for highlight groups with document_highlight() (#13614)
Currently it's not 100% clear that without setting these, using the autocomds
to utilize the `textDocument/documentHighlight` functionality, nothing will
actually be visible since the highlight groups don't have any details. This
just adds in a couple simple extra notes to make sure that's done
Diffstat (limited to 'runtime/lua/vim/lsp/buf.lua')
| -rw-r--r-- | runtime/lua/vim/lsp/buf.lua | 12 |
1 files changed, 9 insertions, 3 deletions
diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua index 00219b6d98..31116985e2 100644 --- a/runtime/lua/vim/lsp/buf.lua +++ b/runtime/lua/vim/lsp/buf.lua @@ -310,15 +310,21 @@ function M.workspace_symbol(query) request('workspace/symbol', params) end ---- Send request to server to resolve document highlights for the ---- current text document position. This request can be associated ---- to key mapping or to events such as `CursorHold`, eg: +--- Send request to the server to resolve document highlights for the current +--- text document position. This request can be triggered by a key mapping or +--- by events such as `CursorHold`, eg: --- --- <pre> --- vim.api.nvim_command [[autocmd CursorHold <buffer> lua vim.lsp.buf.document_highlight()]] --- vim.api.nvim_command [[autocmd CursorHoldI <buffer> lua vim.lsp.buf.document_highlight()]] --- vim.api.nvim_command [[autocmd CursorMoved <buffer> lua vim.lsp.buf.clear_references()]] --- </pre> +--- +--- Note: Usage of |vim.lsp.buf.document_highlight()| requires the following highlight groups +--- to be defined or you won't be able to see the actual highlights. +--- |LspReferenceText| +--- |LspReferenceRead| +--- |LspReferenceWrite| function M.document_highlight() local params = util.make_position_params() request('textDocument/documentHighlight', params) |