commit 864f25d6b08ccfe17e0cf3fbc30639005c0145e0
parent 5897994cb75b5b64a34017873119c87a75c42375
Author: Riley Bruins <ribru17@hotmail.com>
Date: Mon, 25 Nov 2024 20:56:18 -0800
docs: more accurate typing for LSP references context
**Problem:** The `context` parameter for `references()` is just typed as
a table, which is unhelpful.
**Solution:** Properly type it as an `lsp.ReferenceContext`!
Diffstat:
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt
@@ -1448,7 +1448,7 @@ references({context}, {opts}) *vim.lsp.buf.references()*
window.
Parameters: ~
- • {context} (`table?`) Context for the request
+ • {context} (`lsp.ReferenceContext?`) Context for the request
• {opts} (`vim.lsp.ListOpts?`) See |vim.lsp.ListOpts|.
See also: ~
diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua
@@ -736,7 +736,7 @@ end
--- Lists all the references to the symbol under the cursor in the quickfix window.
---
----@param context (table|nil) Context for the request
+---@param context lsp.ReferenceContext? Context for the request
---@see https://microsoft.github.io/language-server-protocol/specifications/specification-current/#textDocument_references
---@param opts? vim.lsp.ListOpts
function M.references(context, opts)