diff options
| author | Maria José Solano <majosolano99@gmail.com> | 2024-02-19 18:28:07 -0800 |
|---|---|---|
| committer | Lewis Russell <me@lewisr.dev> | 2024-03-06 19:37:20 +0000 |
| commit | 0101bdaa1ad8b09ebd5ef5551faf077f39be238c (patch) | |
| tree | 228e8fee6e039c4df5614f0354f2b49f3285657f /runtime/lua/vim/lsp/client.lua | |
| parent | 191cca2566a8afe2b2f2744f3eb763d810cc416c (diff) | |
| download | rneovim-0101bdaa1ad8b09ebd5ef5551faf077f39be238c.tar.gz rneovim-0101bdaa1ad8b09ebd5ef5551faf077f39be238c.tar.bz2 rneovim-0101bdaa1ad8b09ebd5ef5551faf077f39be238c.zip | |
docs(lsp): nits and typos in client.lua
Diffstat (limited to 'runtime/lua/vim/lsp/client.lua')
| -rw-r--r-- | runtime/lua/vim/lsp/client.lua | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/runtime/lua/vim/lsp/client.lua b/runtime/lua/vim/lsp/client.lua index 6dd898bea7..d0054e073c 100644 --- a/runtime/lua/vim/lsp/client.lua +++ b/runtime/lua/vim/lsp/client.lua @@ -156,7 +156,7 @@ local validate = vim.validate --- @field handlers table<string,lsp.Handler> --- --- The current pending requests in flight to the server. Entries are key-value ---- pairs with the key being the request ID while the value is a table with +--- pairs with the key being the request id while the value is a table with --- `type`, `bufnr`, and `method` key-value pairs. `type` is either "pending" --- for an active request, or "cancel" for a cancel request. It will be --- "complete" ephemerally while executing |LspRequest| autocmds when replies @@ -167,8 +167,8 @@ local validate = vim.validate --- to |vim.lsp.start_client()|. --- @field config vim.lsp.ClientConfig --- ---- Response from the server sent on ---- initialize` describing the server's capabilities. +--- Response from the server sent on `initialize` describing the server's +--- capabilities. --- @field server_capabilities lsp.ServerCapabilities? --- --- A ring buffer (|vim.ringbuf()|) containing progress messages @@ -217,10 +217,11 @@ local validate = vim.validate --- Sends a request to the server. --- This is a thin wrapper around {client.rpc.request} with some additional --- checking. ---- If {handler} is not specified, If one is not found there, then an error ---- will occur. Returns: {status}, {[client_id]}. {status} is a boolean ---- indicating if the notification was successful. If it is `false`, then it ---- will always be `false` (the client has shutdown). +--- If {handler} is not specified and if there's no respective global +--- handler, then an error will occur. +--- Returns: {status}, {[client_id]}. {status} is a boolean indicating if +--- the notification was successful. If it is `false`, then it will always +--- be `false` (the client has shutdown). --- If {status} is `true`, the function returns {request_id} as the second --- result. You can use this with `client.cancel_request(request_id)` to cancel --- the request. |