mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-12-11 00:52:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(diagnostic): diagnostic.Opts.Float extend open_floating_preview.Opts #30058

Browse Source 
Problem: the opts table also is param of util.open_floating_preview,
vim.diagnostic.Opts.Float missing some fields of open_floating_preview.

Solution: diagnostic.Opts.Float extend util.open_floating_preview.Opts

Fix #29267
This commit is contained in:
glepnir
2025-11-19 13:52:30 +08:00
committed by GitHub
parent c22b03c771
commit b65aadc03e
2 changed files with 5 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
runtime/doc/diagnostic.txt
View File

@@ -568,6 +568,8 @@ Lua module: vim.diagnostic *diagnostic-api*
|vim.diagnostic.Opts.Jump|. |vim.diagnostic.Opts.Jump|.
*vim.diagnostic.Opts.Float* *vim.diagnostic.Opts.Float*
Extends: |vim.lsp.util.open_floating_preview.Opts|
Fields: ~ Fields: ~
• {bufnr}? (`integer`, default: current buffer) Buffer number • {bufnr}? (`integer`, default: current buffer) Buffer number
@@ -576,7 +578,7 @@ Lua module: vim.diagnostic *diagnostic-api*
namespace(s). namespace(s).
• {scope}? (`'line'|'buffer'|'cursor'|'c'|'l'|'b'`, default: • {scope}? (`'line'|'buffer'|'cursor'|'c'|'l'|'b'`, default:
`line`) Show diagnostics from the whole buffer `line`) Show diagnostics from the whole buffer
(`buffer"`, the current cursor line (`line`), or the (`buffer`), the current cursor line (`line`), or the
current cursor position (`cursor`). Shorthand current cursor position (`cursor`). Shorthand
versions are also accepted (`c` for `cursor`, `l` versions are also accepted (`c` for `cursor`, `l`
for `line`, `b` for `buffer`). for `line`, `b` for `buffer`).
@@ -625,8 +627,6 @@ Lua module: vim.diagnostic *diagnostic-api*
Same as {prefix}, but appends the text to the Same as {prefix}, but appends the text to the
diagnostic instead of prepending it. Overrides the diagnostic instead of prepending it. Overrides the
setting from |vim.diagnostic.config()|. setting from |vim.diagnostic.config()|.
• {focus_id}? (`string`)
• {border}? (`string|string[]`) see |nvim_open_win()|.
*vim.diagnostic.Opts.Jump* *vim.diagnostic.Opts.Jump*

8
runtime/lua/vim/diagnostic.lua
View File

@@ -119,7 +119,7 @@ end
--- @field signs vim.diagnostic.Opts.Signs --- @field signs vim.diagnostic.Opts.Signs
--- @field severity_sort {reverse?:boolean} --- @field severity_sort {reverse?:boolean}
--- @class vim.diagnostic.Opts.Float --- @class vim.diagnostic.Opts.Float : vim.lsp.util.open_floating_preview.Opts
--- ---
--- Buffer number to show diagnostics from. --- Buffer number to show diagnostics from.
--- (default: current buffer) --- (default: current buffer)
@@ -128,7 +128,7 @@ end
--- Limit diagnostics to the given namespace(s). --- Limit diagnostics to the given namespace(s).
--- @field namespace? integer|integer[] --- @field namespace? integer|integer[]
--- ---
--- Show diagnostics from the whole buffer (`buffer"`, the current cursor line --- Show diagnostics from the whole buffer (`buffer`), the current cursor line
--- (`line`), or the current cursor position (`cursor`). Shorthand versions --- (`line`), or the current cursor position (`cursor`). Shorthand versions
--- are also accepted (`c` for `cursor`, `l` for `line`, `b` for `buffer`). --- are also accepted (`c` for `cursor`, `l` for `line`, `b` for `buffer`).
--- (default: `line`) --- (default: `line`)
@@ -183,10 +183,6 @@ end
--- prepending it. --- prepending it.
--- Overrides the setting from |vim.diagnostic.config()|. --- Overrides the setting from |vim.diagnostic.config()|.
--- @field suffix? string|table|(fun(diagnostic:vim.Diagnostic,i:integer,total:integer): string, string) --- @field suffix? string|table|(fun(diagnostic:vim.Diagnostic,i:integer,total:integer): string, string)
---
--- @field focus_id? string
---
--- @field border? string|string[] see |nvim_open_win()|.
--- @class vim.diagnostic.Opts.Underline --- @class vim.diagnostic.Opts.Underline
--- ---