docs(lsp): hover window controls #30347

This commit is contained in:
Tristan Knight
2024-09-19 16:00:08 +01:00
committed by GitHub
parent 84e85aeb10
commit adbaaa5225
2 changed files with 11 additions and 2 deletions

View File

@@ -29,7 +29,12 @@ local function request(method, params, handler)
end
--- Displays hover information about the symbol under the cursor in a floating
--- window. Calling the function twice will jump into the floating window.
--- window. The window will be dismissed on cursor move.
--- Calling the function twice will jump into the floating window
--- (thus by default, "KK" will open the hover window and focus it).
--- In the floating window, all commands and mappings are available as usual,
--- except that "q" dismisses the window.
--- You can scroll the contents the same as you would any other buffer.
function M.hover()
local params = util.make_position_params()
request(ms.textDocument_hover, params)