diff options
| author | Yi Ming <ofseed@foxmail.com> | 2024-11-29 00:08:27 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-11-28 08:08:27 -0800 |
| commit | 146b8300a145efa64e579527da8606546a36162b (patch) | |
| tree | 09ddbd41dde0af6f9fa0a635435bad634e84497a | |
| parent | 864f25d6b08ccfe17e0cf3fbc30639005c0145e0 (diff) | |
| download | rneovim-146b8300a145efa64e579527da8606546a36162b.tar.gz rneovim-146b8300a145efa64e579527da8606546a36162b.tar.bz2 rneovim-146b8300a145efa64e579527da8606546a36162b.zip | |
docs(lsp): update example, optional parameters #31299
| -rw-r--r-- | runtime/doc/lsp.txt | 9 | ||||
| -rw-r--r-- | runtime/lua/vim/lsp/buf.lua | 2 | ||||
| -rw-r--r-- | runtime/lua/vim/lsp/client.lua | 4 |
3 files changed, 8 insertions, 7 deletions
diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt index 38e9b046cd..1693ff5e4f 100644 --- a/runtime/doc/lsp.txt +++ b/runtime/doc/lsp.txt @@ -975,7 +975,7 @@ Lua module: vim.lsp.client *lsp-client* • {dynamic_capabilities} (`lsp.DynamicCapabilities`) • {request} (`fun(self: vim.lsp.Client, method: string, params: table?, handler: lsp.Handler?, bufnr: integer?): boolean, integer?`) See |Client:request()|. - • {request_sync} (`fun(self: vim.lsp.Client, method: string, params: table, timeout_ms: integer?, bufnr: integer): {err: lsp.ResponseError?, result:any}?, string?`) + • {request_sync} (`fun(self: vim.lsp.Client, method: string, params: table, timeout_ms: integer?, bufnr: integer?): {err: lsp.ResponseError?, result:any}?, string?`) See |Client:request_sync()|. • {notify} (`fun(self: vim.lsp.Client, method: string, params: table?): boolean`) See |Client:notify()|. @@ -1179,7 +1179,7 @@ Client:request({method}, {params}, {handler}, {bufnr}) • {method} (`string`) LSP method name. • {params} (`table?`) LSP request params. • {handler} (`lsp.Handler?`) Response |lsp-handler| for this method. - • {bufnr} (`integer?`) Buffer handle. 0 for current (default). + • {bufnr} (`integer?`) (default: 0) Buffer handle, or 0 for current. Return (multiple): ~ (`boolean`) status indicates whether the request was successful. If it @@ -1201,7 +1201,8 @@ Client:request_sync({method}, {params}, {timeout_ms}, {bufnr}) • {params} (`table`) LSP request params. • {timeout_ms} (`integer?`) Maximum time in milliseconds to wait for a result. Defaults to 1000 - • {bufnr} (`integer`) Buffer handle (0 for current). + • {bufnr} (`integer?`) (default: 0) Buffer handle, or 0 for + current. Return (multiple): ~ (`{err: lsp.ResponseError?, result:any}?`) `result` and `err` from the @@ -1385,7 +1386,7 @@ format({opts}) *vim.lsp.buf.format()* predicate are included. Example: >lua -- Never request typescript-language-server for formatting vim.lsp.buf.format { - filter = function(client) return client.name ~= "tsserver" end + filter = function(client) return client.name ~= "ts_ls" end } < • {async}? (`boolean`, default: false) If true the method diff --git a/runtime/lua/vim/lsp/buf.lua b/runtime/lua/vim/lsp/buf.lua index e4b6b9ac1e..10479807a2 100644 --- a/runtime/lua/vim/lsp/buf.lua +++ b/runtime/lua/vim/lsp/buf.lua @@ -487,7 +487,7 @@ end --- ```lua --- -- Never request typescript-language-server for formatting --- vim.lsp.buf.format { ---- filter = function(client) return client.name ~= "tsserver" end +--- filter = function(client) return client.name ~= "ts_ls" end --- } --- ``` --- @field filter? fun(client: vim.lsp.Client): boolean? diff --git a/runtime/lua/vim/lsp/client.lua b/runtime/lua/vim/lsp/client.lua index 7c2b7192f5..a14b6ccda6 100644 --- a/runtime/lua/vim/lsp/client.lua +++ b/runtime/lua/vim/lsp/client.lua @@ -639,7 +639,7 @@ end --- @param method string LSP method name. --- @param params? table LSP request params. --- @param handler? lsp.Handler Response |lsp-handler| for this method. ---- @param bufnr? integer Buffer handle. 0 for current (default). +--- @param bufnr? integer (default: 0) Buffer handle, or 0 for current. --- @return boolean status indicates whether the request was successful. --- If it is `false`, then it will always be `false` (the client has shutdown). --- @return integer? request_id Can be used with |Client:cancel_request()|. @@ -718,7 +718,7 @@ end --- @param params table LSP request params. --- @param timeout_ms integer? Maximum time in milliseconds to wait for --- a result. Defaults to 1000 ---- @param bufnr integer Buffer handle (0 for current). +--- @param bufnr? integer (default: 0) Buffer handle, or 0 for current. --- @return {err: lsp.ResponseError?, result:any}? `result` and `err` from the |lsp-handler|. --- `nil` is the request was unsuccessful --- @return string? err On timeout, cancel or error, where `err` is a |