aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim/lsp/diagnostic.lua
diff options
context:
space:
mode:
authorMathias Fußenegger <mfussenegger@users.noreply.github.com>2021-09-01 14:28:15 +0200
committerGitHub <noreply@github.com>2021-09-01 14:28:15 +0200
commit5c643dee7bca26c933f7abfcf2757ccd8cb07af6 (patch)
treee2e046dfa6938abf196a05f969a710122bb52bb3 /runtime/lua/vim/lsp/diagnostic.lua
parent684550ff38b036fd7f3b2ac75121cfd0b3b9c9ca (diff)
downloadrneovim-5c643dee7bca26c933f7abfcf2757ccd8cb07af6.tar.gz
rneovim-5c643dee7bca26c933f7abfcf2757ccd8cb07af6.tar.bz2
rneovim-5c643dee7bca26c933f7abfcf2757ccd8cb07af6.zip
docs(lsp): remove private lsp.diagnostic functions from docs (#15541)
Both `apply_to_diagnostic_items` and `show_diagnostics` are local functions and cannot be called by users.
Diffstat (limited to 'runtime/lua/vim/lsp/diagnostic.lua')
-rw-r--r--runtime/lua/vim/lsp/diagnostic.lua9
1 files changed, 6 insertions, 3 deletions
diff --git a/runtime/lua/vim/lsp/diagnostic.lua b/runtime/lua/vim/lsp/diagnostic.lua
index 45aeb17465..8538ce8deb 100644
--- a/runtime/lua/vim/lsp/diagnostic.lua
+++ b/runtime/lua/vim/lsp/diagnostic.lua
@@ -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