From 864f25d6b08ccfe17e0cf3fbc30639005c0145e0 Mon Sep 17 00:00:00 2001 From: Riley Bruins Date: Mon, 25 Nov 2024 20:56:18 -0800 Subject: 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`! --- runtime/doc/lsp.txt | 2 +- runtime/lua/vim/lsp/buf.lua | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) (limited to 'runtime') diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt index 350edc068f..38e9b046cd 100644 --- 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 index aca6bf27f4..e4b6b9ac1e 100644 --- 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) -- cgit