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): remove private lsp.diagnostic functions from docs (#15541)

Browse Source 
Both `apply_to_diagnostic_items` and `show_diagnostics` are local
functions and cannot be called by users.
This commit is contained in:
Mathias Fußenegger 2021-09-01 14:28:15 +02:00 committed by GitHub
parent 684550ff38
commit 5c643dee7b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

55
runtime/doc/lsp.txt
View File

@ -1199,34 +1199,6 @@ workspace_symbol({query}) *vim.lsp.buf.workspace_symbol()*
==============================================================================
Lua module: vim.lsp.diagnostic *lsp-diagnostic*
*vim.lsp.diagnostic.apply_to_diagnostic_items()*
apply_to_diagnostic_items({item_handler}, {command}, {opts})
Gets diagnostics, converts them to quickfix/location list
items, and applies the item_handler callback to the items.
Parameters: ~
{item_handler} function Callback to apply to the
diagnostic items
{command} string|nil Command to execute after
applying the item_handler
{opts} table|nil Configuration table. Keys:
• {client_id}: (number)
• If nil, will consider all clients
attached to buffer.
• {severity}: (DiagnosticSeverity)
• Exclusive severity to consider.
Overrides {severity_limit}
• {severity_limit}: (DiagnosticSeverity)
• Limit severity of diagnostics found.
E.g. "Warning" means { "Error",
"Warning" } will be valid.
• {workspace}: (boolean, default false)
• Set the list with workspace
diagnostics
*vim.lsp.diagnostic.clear()*
clear({bufnr}, {client_id}, {diagnostic_ns}, {sign_ns})
Clears the currently displayed diagnostics
@ -1649,31 +1621,6 @@ set_virtual_text({diagnostics}, {bufnr}, {client_id}, {diagnostic_ns}, {opts})
E.g. "Warning" means { "Error",
"Warning" } will be valid.
*vim.lsp.diagnostic.show_diagnostics()*
show_diagnostics({opts}, {diagnostics})
Open a floating window with the provided diagnostics
The floating window can be customized with the following
highlight groups: >
LspDiagnosticsFloatingError
LspDiagnosticsFloatingWarning
LspDiagnosticsFloatingInformation
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: ~
@ -1690,6 +1637,8 @@ show_line_diagnostics({opts}, {buf_nr}, {line_nr}, {client_id})
*vim.lsp.diagnostic.show_position_diagnostics()*
show_position_diagnostics({opts}, {buf_nr}, {position})
Open a floating window with the diagnostics from {position}
Parameters: ~
{opts} table|nil Configuration keys
• severity: (DiagnosticSeverity, default nil)

9
runtime/lua/vim/lsp/diagnostic.lua
View File

@ -1214,9 +1214,8 @@ function M.redraw(bufnr, client_id)
)
end
-- }}}
-- Diagnostic User Functions {{{
---@private
--- Open a floating window with the provided diagnostics
---
--- The floating window can be customized with the following highlight groups:
@ -1265,8 +1264,11 @@ local function show_diagnostics(opts, diagnostics)
return popup_bufnr, winnr
end
--- Open a floating window with the diagnostics from {position}
-- }}}
-- Diagnostic User Functions {{{
--- Open a floating window with the diagnostics from {position}
---@param opts table|nil Configuration keys
--- - severity: (DiagnosticSeverity, default nil)
--- - Only return diagnostics with this severity. Overrides severity_limit
@ -1334,6 +1336,7 @@ function M.reset(client_id, buffer_client_map)
end)
end
---@private
--- Gets diagnostics, converts them to quickfix/location list items, and applies the item_handler callback to the items.
---@param item_handler function Callback to apply to the diagnostic items
---@param command string|nil Command to execute after applying the item_handler