diff options
author | Mathias Fußenegger <mfussenegger@users.noreply.github.com> | 2021-09-01 14:28:15 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2021-09-01 14:28:15 +0200 |
commit | 5c643dee7bca26c933f7abfcf2757ccd8cb07af6 (patch) | |
tree | e2e046dfa6938abf196a05f969a710122bb52bb3 | |
parent | 684550ff38b036fd7f3b2ac75121cfd0b3b9c9ca (diff) | |
download | rneovim-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.
-rw-r--r-- | runtime/doc/lsp.txt | 55 | ||||
-rw-r--r-- | runtime/lua/vim/lsp/diagnostic.lua | 9 |
2 files changed, 8 insertions, 56 deletions
diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt index cc03188f13..0c94b79600 100644 --- a/runtime/doc/lsp.txt +++ b/runtime/doc/lsp.txt @@ -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) 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 |