IntenseFinance/neovim
3
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-02-25 18:55:25 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs(lsp): use direct link to formattingOptions in format docs (#19558)

Browse Source 
Also changes `@see` to `See` to avoid the break to a dedicated "See
also" block in the generated vimdoc
This commit is contained in:
Mathias Fußenegger 2022-07-28 19:41:30 +02:00 committed by GitHub
parent 98915f88b2
commit b25abbf4b8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
runtime/doc/lsp.txt
View File

@ -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.

2
runtime/lua/vim/lsp/buf.lua
View File

@ -157,7 +157,7 @@ end
--- - formatting_options (table|nil):
--- Can be used to specify FormattingOptions. Some unspecified options will be
--- automatically derived from the current Neovim options.
--- @see https://microsoft.github.io/language-server-protocol/specification#textDocument_formatting
--- 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):