diff options
| author | tom-anders <13141438+tom-anders@users.noreply.github.com> | 2024-05-04 10:10:44 +0200 |
|---|---|---|
| committer | tom-anders <13141438+tom-anders@users.noreply.github.com> | 2024-05-07 21:27:21 +0200 |
| commit | b0cc85c00504dc5530ab5d6c5fa03f3fa96d5a1a (patch) | |
| tree | 343f0201c338ed04bb4f7883ae09bda2385518a5 | |
| parent | 80d108eeee89c095e0c1226a558a690a708abaa1 (diff) | |
| download | rneovim-b0cc85c00504dc5530ab5d6c5fa03f3fa96d5a1a.tar.gz rneovim-b0cc85c00504dc5530ab5d6c5fa03f3fa96d5a1a.tar.bz2 rneovim-b0cc85c00504dc5530ab5d6c5fa03f3fa96d5a1a.zip | |
docs(lsp): document vim.lsp.ListOpts.loclist
| -rw-r--r-- | runtime/doc/lsp.txt | 9 | ||||
| -rw-r--r-- | runtime/lua/vim/lsp/buf.lua | 9 | ||||
| -rw-r--r-- | runtime/lua/vim/lsp/handlers.lua | 5 |
3 files changed, 9 insertions, 14 deletions
diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt index 8f6913b1c9..6cb01ee3da 100644 --- a/runtime/doc/lsp.txt +++ b/runtime/doc/lsp.txt @@ -1201,12 +1201,11 @@ Lua module: vim.lsp.buf *lsp-buf* vim.lsp.buf.references(nil, { on_list = on_list }) < - If you prefer loclist do something like this: >lua - local function on_list(options) - vim.fn.setloclist(0, {}, ' ', options) - vim.cmd.lopen() - end + If you prefer loclist instead of qflist: >lua + vim.lsp.buf.definition({ loclist = true }) + vim.lsp.buf.references(nil, { loclist = true }) < + • {loclist}? (`boolean`) *vim.lsp.LocationOpts* Extends: |vim.lsp.ListOpts| diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua index 820ff9c2ca..e05acff3df 100644 --- a/runtime/lua/vim/lsp/buf.lua +++ b/runtime/lua/vim/lsp/buf.lua @@ -62,14 +62,13 @@ end --- vim.lsp.buf.references(nil, { on_list = on_list }) --- ``` --- ---- If you prefer loclist do something like this: +--- If you prefer loclist instead of qflist: --- ```lua ---- local function on_list(options) ---- vim.fn.setloclist(0, {}, ' ', options) ---- vim.cmd.lopen() ---- end +--- vim.lsp.buf.definition({ loclist = true }) +--- vim.lsp.buf.references(nil, { loclist = true }) --- ``` --- @field on_list? fun(t: vim.lsp.LocationOpts.OnList) +--- @field loclist? boolean --- @class vim.lsp.LocationOpts.OnList --- @field items table[] Structured like |setqflist-what| diff --git a/runtime/lua/vim/lsp/handlers.lua b/runtime/lua/vim/lsp/handlers.lua index c639a317cf..205de68101 100644 --- a/runtime/lua/vim/lsp/handlers.lua +++ b/runtime/lua/vim/lsp/handlers.lua @@ -268,10 +268,7 @@ end --- Return a function that converts LSP responses to list items and opens the list --- ---- The returned function has an optional {config} parameter that accepts a table ---- with the following keys: ---- ---- loclist: (boolean) use the location list (default is to use the quickfix list) +--- The returned function has an optional {config} parameter that accepts |vim.lsp.ListOpts| --- ---@param map_result fun(resp, bufnr: integer): table to convert the response ---@param entity string name of the resource used in a `not found` error message |