neovim

commit 2d24558c285198d2e725c83a8c4ad4d90797c950
parent fb74fd2954ee4eeee566bb2fcfd480a4281f1e4a
Author: glepnir <glephunter@gmail.com>
Date:   Sun, 13 Oct 2024 18:44:05 +0800

docs: update autotrigger description of vim.lsp.compleiton.BufferOpts (#30796)

Currently the behavior of autotrigger is not well documented.
Diffstat:
M
runtime/doc/lsp.txt
 | 
5
+++--
M
runtime/lua/vim/lsp/completion.lua
 | 
2
+-

2 files changed, 4 insertions(+), 3 deletions(-)
diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt
@@ -1639,8 +1639,9 @@ Lua module: vim.lsp.completion                                *lsp-completion*
 *vim.lsp.completion.BufferOpts*
 
     Fields: ~
-      • {autotrigger}?  (`boolean`) Whether to trigger completion
-                        automatically. Default: false
+      • {autotrigger}?  (`boolean`) Default: false When true, completion
+                        triggers automatically based on the server's
+                        `triggerCharacters`.
       • {convert}?      (`fun(item: lsp.CompletionItem): table`) Transforms an
                         LSP CompletionItem to |complete-items|.
 
diff --git a/runtime/lua/vim/lsp/completion.lua b/runtime/lua/vim/lsp/completion.lua
@@ -592,7 +592,7 @@ local function on_complete_done()
 end
 
 --- @class vim.lsp.completion.BufferOpts
---- @field autotrigger? boolean Whether to trigger completion automatically. Default: false
+--- @field autotrigger? boolean  Default: false When true, completion triggers automatically based on the server's `triggerCharacters`.
 --- @field convert? fun(item: lsp.CompletionItem): table Transforms an LSP CompletionItem to |complete-items|.
 
 ---@param client_id integer