diff options
| author | glepnir <glephunter@gmail.com> | 2024-10-13 18:44:05 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-10-13 12:44:05 +0200 |
| commit | 2d24558c285198d2e725c83a8c4ad4d90797c950 (patch) | |
| tree | 5a234f9c709fee88b9bcb7f5172011ef4bfa38d5 | |
| parent | fb74fd2954ee4eeee566bb2fcfd480a4281f1e4a (diff) | |
| download | rneovim-2d24558c285198d2e725c83a8c4ad4d90797c950.tar.gz rneovim-2d24558c285198d2e725c83a8c4ad4d90797c950.tar.bz2 rneovim-2d24558c285198d2e725c83a8c4ad4d90797c950.zip | |
docs: update autotrigger description of vim.lsp.compleiton.BufferOpts (#30796)
Currently the behavior of autotrigger is not well documented.
| -rw-r--r-- | runtime/doc/lsp.txt | 5 | ||||
| -rw-r--r-- | 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 index 20503d46b8..addc093a3e 100644 --- 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 index 14fad987e0..3df506d23a 100644 --- 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 |