diff options
| author | Jongwook Choi <wookayin@gmail.com> | 2024-05-07 14:09:27 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-05-07 11:09:27 -0700 |
| commit | e14e75099883e6904cf3575b612f3820cd122938 (patch) | |
| tree | 979ff495ca478d8c401b6979088926800e667253 /runtime/doc | |
| parent | e7f50f43c82225eeecbff531b55d6ed26fad1bf5 (diff) | |
| download | rneovim-e14e75099883e6904cf3575b612f3820cd122938.tar.gz rneovim-e14e75099883e6904cf3575b612f3820cd122938.tar.bz2 rneovim-e14e75099883e6904cf3575b612f3820cd122938.zip | |
fix(lsp): rename LspProgress data.result => data.params #28632
Rename the field `result` to `params` in the `data` table for
`LspProgress` autocmds. This aligns with LspNotify.
The previous name was chosen because the initial handler implementation
mistakenly had a parameter name `result` instead of `params` for the
`$/progress` LSP "notification" handler. However, `params` would be a
more appropriate name that is more consistent with the underlying LSP
type (`ProgressParams`).
See also: https://microsoft.github.io/language-server-protocol/specifications/specification-current/#progress
Diffstat (limited to 'runtime/doc')
| -rw-r--r-- | runtime/doc/lsp.txt | 6 | ||||
| -rw-r--r-- | runtime/doc/news.txt | 2 |
2 files changed, 5 insertions, 3 deletions
diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt index 40a80b1261..5b2b8d6341 100644 --- a/runtime/doc/lsp.txt +++ b/runtime/doc/lsp.txt @@ -544,14 +544,14 @@ LspNotify *LspNotify* LspProgress *LspProgress* Upon receipt of a progress notification from the server. Notifications can be polled from a `progress` ring buffer of a |vim.lsp.Client| or use - |vim.lsp.status()| to get an aggregate message + |vim.lsp.status()| to get an aggregate message. If the server sends a "work done progress", the `pattern` is set to `kind` (one of `begin`, `report` or `end`). When used from Lua, the event contains a `data` table with `client_id` and - `result` properties. `result` will contain the request params sent by the - server. + `params` properties. `params` will contain the request params sent by the + server (see `lsp.ProgressParams`). Example: >vim autocmd LspProgress * redrawstatus diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt index ed994472ac..6f13e505f1 100644 --- a/runtime/doc/news.txt +++ b/runtime/doc/news.txt @@ -178,6 +178,8 @@ cycle (Nvim HEAD, the "master" branch). • Renamed vim.snippet.exit() to vim.snippet.stop(). +• Changed |event-data| table for |LspProgress|: renamed `result` to `params`. + ============================================================================== NEW FEATURES *news-features* |