aboutsummaryrefslogtreecommitdiff
path: root/runtime/doc
diff options
context:
space:
mode:
authorMathias Fußenegger <mfussenegger@users.noreply.github.com>2022-07-28 19:41:30 +0200
committerGitHub <noreply@github.com>2022-07-28 19:41:30 +0200
commitb25abbf4b8a08899bba87809124c882928d99e21 (patch)
treefe06f1018eb16d5e3762f966a87f8e6cfc42d5bc /runtime/doc
parent98915f88b2d4b0e7f2ca643cd4648316ec9cddb8 (diff)
downloadrneovim-b25abbf4b8a08899bba87809124c882928d99e21.tar.gz
rneovim-b25abbf4b8a08899bba87809124c882928d99e21.tar.bz2
rneovim-b25abbf4b8a08899bba87809124c882928d99e21.zip
docs(lsp): use direct link to formattingOptions in format docs (#19558)
Also changes `@see` to `See` to avoid the break to a dedicated "See also" block in the generated vimdoc
Diffstat (limited to 'runtime/doc')
-rw-r--r--runtime/doc/lsp.txt41
1 files changed, 21 insertions, 20 deletions
diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt
index 12ed17a7cc..11f96db8c9 100644
--- a/runtime/doc/lsp.txt
+++ b/runtime/doc/lsp.txt
@@ -1202,32 +1202,33 @@ format({options}) *vim.lsp.buf.format()*
• formatting_options (table|nil): Can be used
to specify FormattingOptions. Some
unspecified options will be automatically
- derived from the current Neovim options.
-
- See also: ~
- https://microsoft.github.io/language-server-protocol/specification#textDocument_formatting
- • timeout_ms (integer|nil, default 1000): Time in
- milliseconds to block for formatting requests. No effect
- if async=true
- • bufnr (number|nil): Restrict formatting to the clients
- attached to the given buffer, defaults to the current
- buffer (0).
- • filter (function|nil): Predicate used to filter clients.
- Receives a client as argument and must return a boolean.
- Clients matching the predicate are included. Example: • >
+ derived from the current Neovim options. See https://microsoft.github.io/language-server-protocol/specifications/lsp/3.17/specification/#formattingOptions
+ • timeout_ms (integer|nil, default 1000): Time
+ in milliseconds to block for formatting
+ requests. No effect if async=true
+ • bufnr (number|nil): Restrict formatting to
+ the clients attached to the given buffer,
+ defaults to the current buffer (0).
+ • filter (function|nil): Predicate used to
+ filter clients. Receives a client as argument
+ and must return a boolean. Clients matching
+ the predicate are included. Example: • >
-- Never request typescript-language-server for formatting
vim.lsp.buf.format {
filter = function(client) return client.name ~= "tsserver" end
}
<
- • async boolean|nil If true the method won't block.
- Defaults to false. Editing the buffer while formatting
- asynchronous can lead to unexpected changes.
- • id (number|nil): Restrict formatting to the client with
- ID (client.id) matching this field.
- • name (string|nil): Restrict formatting to the client
- with name (client.name) matching this field.
+ • async boolean|nil If true the method won't
+ block. Defaults to false. Editing the buffer
+ while formatting asynchronous can lead to
+ unexpected changes.
+ • id (number|nil): Restrict formatting to the
+ client with ID (client.id) matching this
+ field.
+ • name (string|nil): Restrict formatting to the
+ client with name (client.name) matching this
+ field.
formatting({options}) *vim.lsp.buf.formatting()*
Formats the current buffer.