neovim

commit b0cc85c00504dc5530ab5d6c5fa03f3fa96d5a1a
parent 80d108eeee89c095e0c1226a558a690a708abaa1
Author: tom-anders <13141438+tom-anders@users.noreply.github.com>
Date:   Sat,  4 May 2024 10:10:44 +0200

docs(lsp): document vim.lsp.ListOpts.loclist

Diffstat:
M
runtime/doc/lsp.txt
 | 
9
++++-----
M
runtime/lua/vim/lsp/buf.lua
 | 
9
++++-----
M
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
@@ -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
@@ -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
@@ -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