mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-11-25 03:30:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: regenerate (#15431)

Browse Source 
Co-authored-by: marvim <marvim@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2021-08-19 20:28:18 +02:00
committed by GitHub
parent 69741107e6
commit 2ae9ff1285
1 changed files with 59 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

84
runtime/doc/lsp.txt
View File

@@ -819,9 +819,9 @@ start_client({config}) *vim.lsp.start_client()*
table. table.
Parameters: ~ Parameters: ~
{root_dir} (required, string) Directory where {root_dir} (string) Directory where the LSP
the LSP server will base its rootUri server will base its rootUri on
on initialization. initialization.
{cmd} (required, string or list treated {cmd} (required, string or list treated
like |jobstart()|) Base command that like |jobstart()|) Base command that
initiates the LSP client. initiates the LSP client.
@@ -1258,7 +1258,7 @@ enable({bufnr}, {client_id}) *vim.lsp.diagnostic.enable()*
the given client. The default is to enable the given client. The default is to enable
diagnostics for all attached clients. diagnostics for all attached clients.
get({bufnr}, {client_id}) *vim.lsp.diagnostic.get()* get({bufnr}, {client_id}, {predicate}) *vim.lsp.diagnostic.get()*
Return associated diagnostics for bufnr Return associated diagnostics for bufnr
Parameters: ~ Parameters: ~
@@ -1266,6 +1266,8 @@ get({bufnr}, {client_id}) *vim.lsp.diagnostic.get()*
{client_id} number|nil If nil, then return all of the {client_id} number|nil If nil, then return all of the
diagnostics. Else, return just the diagnostics. Else, return just the
diagnostics associated with the client_id. diagnostics associated with the client_id.
{predicate} function|nil Optional function for filtering
diagnostics
get_all({client_id}) *vim.lsp.diagnostic.get_all()* get_all({client_id}) *vim.lsp.diagnostic.get_all()*
Get all diagnostics for clients Get all diagnostics for clients
@@ -1310,18 +1312,18 @@ get_line_diagnostics({bufnr}, {line_nr}, {opts}, {client_id})
Get the diagnostics by line Get the diagnostics by line
Parameters: ~ Parameters: ~
{bufnr} number The buffer number {bufnr} number|nil The buffer number
{line_nr} number The line number {line_nr} number|nil The line number
{opts} table|nil Configuration keys {opts} table|nil Configuration keys
• severity: (DiagnosticSeverity, default nil) • severity: (DiagnosticSeverity, default nil)
• Only return diagnostics with this • Only return diagnostics with this
severity. Overrides severity_limit severity. Overrides severity_limit
• severity_limit: (DiagnosticSeverity, default nil) • severity_limit: (DiagnosticSeverity, default nil)
• Limit severity of diagnostics found. E.g. • Limit severity of diagnostics found.
"Warning" means { "Error", "Warning" } E.g. "Warning" means { "Error",
will be valid. "Warning" } will be valid.
{client_id} number the client id {client_id|nil} number the client id
Return: ~ Return: ~
table Table with map of line number to list of table Table with map of line number to list of
@@ -1656,9 +1658,9 @@ set_virtual_text({diagnostics}, {bufnr}, {client_id}, {diagnostic_ns}, {opts})
E.g. "Warning" means { "Error", E.g. "Warning" means { "Error",
"Warning" } will be valid. "Warning" } will be valid.
*vim.lsp.diagnostic.show_line_diagnostics()* *vim.lsp.diagnostic.show_diagnostics()*
show_line_diagnostics({opts}, {bufnr}, {line_nr}, {client_id}) show_diagnostics({opts}, {diagnostics})
Open a floating window with the diagnostics from {line_nr} Open a floating window with the provided diagnostics
The floating window can be customized with the following The floating window can be customized with the following
highlight groups: > highlight groups: >
@@ -1669,21 +1671,53 @@ show_line_diagnostics({opts}, {bufnr}, {line_nr}, {client_id})
LspDiagnosticsFloatingHint LspDiagnosticsFloatingHint
< <
Parameters: ~
{opts} table Configuration table
• show_header (boolean, default true): Show
"Diagnostics:" header
• all opts for
|vim.lsp.util.open_floating_preview()|
can be used here
{diagnostics} table: The diagnostics to display
Return: ~
table {popup_bufnr, win_id}
*vim.lsp.diagnostic.show_line_diagnostics()*
show_line_diagnostics({opts}, {buf_nr}, {line_nr}, {client_id})
Parameters: ~ Parameters: ~
{opts} table Configuration table {opts} table Configuration table
• show_header (boolean, default true): Show • all opts for
"Diagnostics:" header.
• Plus all the opts for
|vim.lsp.diagnostic.get_line_diagnostics()| |vim.lsp.diagnostic.get_line_diagnostics()|
and |vim.lsp.util.open_floating_preview()| and |show_diagnostics()| can be used here
can be used here. {buf_nr} number|nil The buffer number
{bufnr} number The buffer number {line_nr} number|nil The line number
{line_nr} number The line number
{client_id} number|nil the client id {client_id} number|nil the client id
Return: ~ Return: ~
table {popup_bufnr, win_id} table {popup_bufnr, win_id}
*vim.lsp.diagnostic.show_position_diagnostics()*
show_position_diagnostics({opts}, {buf_nr}, {position})
Parameters: ~
{opts} table|nil Configuration keys
• severity: (DiagnosticSeverity, default nil)
• Only return diagnostics with this
severity. Overrides severity_limit
• severity_limit: (DiagnosticSeverity, default nil)
• Limit severity of diagnostics found. E.g.
"Warning" means { "Error", "Warning" }
will be valid.
• all opts for |show_diagnostics()| can be
used here
{buf_nr} number|nil The buffer number
{position} table|nil The (0,0)-indexed position
Return: ~
table {popup_bufnr, win_id}
============================================================================== ==============================================================================
Lua module: vim.lsp.codelens *lsp-codelens* Lua module: vim.lsp.codelens *lsp-codelens*