diff options
| author | Gregory Anders <greg@gpanders.com> | 2021-09-17 08:57:51 -0600 |
|---|---|---|
| committer | Gregory Anders <greg@gpanders.com> | 2021-09-17 08:57:51 -0600 |
| commit | 15fbc9b69e39e6b8ec746b5cdfcc69f182987a4f (patch) | |
| tree | ef028be23bb042a50c0f6d244b0f178e8099bca1 | |
| parent | 3fd145007c2ecc3dc3ec8f596eb4e13a7e7fd4b5 (diff) | |
| download | rneovim-15fbc9b69e39e6b8ec746b5cdfcc69f182987a4f.tar.gz rneovim-15fbc9b69e39e6b8ec746b5cdfcc69f182987a4f.tar.bz2 rneovim-15fbc9b69e39e6b8ec746b5cdfcc69f182987a4f.zip | |
docs(diagnostics): fix typos
| -rw-r--r-- | runtime/doc/diagnostic.txt | 10 | ||||
| -rw-r--r-- | runtime/lua/vim/diagnostic.lua | 6 |
2 files changed, 8 insertions, 8 deletions
diff --git a/runtime/doc/diagnostic.txt b/runtime/doc/diagnostic.txt index f4975b187f..00132d3fd7 100644 --- a/runtime/doc/diagnostic.txt +++ b/runtime/doc/diagnostic.txt @@ -254,7 +254,7 @@ get({bufnr}, {opts}) *vim.diagnostic.get()* Get current diagnostics. Parameters: ~ - {bufnr} number|nil Buffer number to get diagnistics from. + {bufnr} number|nil Buffer number to get diagnostics from. Use 0 for current buffer or nil for all buffers. {opts} table|nil A table with the following keys: • namespace: (number) Limit diagnostics to the @@ -320,7 +320,7 @@ get_virt_text_chunks({line_diags}, {opts}) insert before virtual text. Return: ~ - an array of [text, hl_group] arrays. This can be passed + array of ({text}, {hl_group}) tuples. This can be passed directly to the {virt_text} option of |nvim_buf_set_extmark()|. @@ -456,7 +456,7 @@ show_line_diagnostics({opts}, {bufnr}, {lnum}) of cursor. Return: ~ - A ({popup_bufnr}, {win_id}) tuple + tuple ({popup_bufnr}, {win_id}) *vim.diagnostic.show_position_diagnostics()* show_position_diagnostics({opts}, {bufnr}, {position}) @@ -465,7 +465,7 @@ show_position_diagnostics({opts}, {bufnr}, {position}) Parameters: ~ {opts} table|nil Configuration table with the same - keys as |vim.lsp.util.open_floatin_preview()| + keys as |vim.lsp.util.open_floating_preview()| in addition to the following: • namespace: (number) Limit diagnostics to the given namespace @@ -478,6 +478,6 @@ show_position_diagnostics({opts}, {bufnr}, {position}) to the current cursor position. Return: ~ - A ({popup_bufnr}, {win_id}) tuple + tuple ({popup_bufnr}, {win_id}) vim:tw=78:ts=8:ft=help:norl: diff --git a/runtime/lua/vim/diagnostic.lua b/runtime/lua/vim/diagnostic.lua index 8f73740dad..dae785647b 100644 --- a/runtime/lua/vim/diagnostic.lua +++ b/runtime/lua/vim/diagnostic.lua @@ -862,7 +862,7 @@ end ---@param opts table|nil Configuration table with the following keys: --- - prefix: (string) Prefix to display before virtual text on line. --- - spacing: (number) Number of spaces to insert before virtual text. ----@return an array of [text, hl_group] arrays. This can be passed directly to +---@return array of ({text}, {hl_group}) tuples. This can be passed directly to --- the {virt_text} option of |nvim_buf_set_extmark()|. function M.get_virt_text_chunks(line_diags, opts) if #line_diags == 0 then @@ -1013,7 +1013,7 @@ end --- - show_header: (boolean, default true) Show "Diagnostics:" header ---@param bufnr number|nil Buffer number. Defaults to the current buffer. ---@param position table|nil The (0,0)-indexed position. Defaults to the current cursor position. ----@return A ({popup_bufnr}, {win_id}) tuple +---@return tuple ({popup_bufnr}, {win_id}) function M.show_position_diagnostics(opts, bufnr, position) vim.validate { opts = { opts, 't', true }, @@ -1045,7 +1045,7 @@ end ---@param opts table Configuration table. See |vim.diagnostic.show_position_diagnostics()|. ---@param bufnr number|nil Buffer number. Defaults to the current buffer. ---@param lnum number|nil Line number. Defaults to line number of cursor. ----@return A ({popup_bufnr}, {win_id}) tuple +---@return tuple ({popup_bufnr}, {win_id}) function M.show_line_diagnostics(opts, bufnr, lnum) vim.validate { opts = { opts, 't', true }, |