mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-12-15 02:45:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(diagnostic): diagnostic.Opts.Float extend open_floating_preview.… (#36612)

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

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

Co-authored-by: glepnir <glephunter@gmail.com>
This commit is contained in:
Justin M. Keyes
2025-11-18 22:05:29 -08:00
committed by GitHub
parent fac7c10eb8
commit 2794d349ad
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

@@ -531,6 +531,8 @@ Lua module: vim.diagnostic *diagnostic-api*
|vim.diagnostic.Opts.Jump|.
*vim.diagnostic.Opts.Float*
Extends: |vim.lsp.util.open_floating_preview.Opts|
Fields: ~
• {bufnr}? (`integer`, default: current buffer) Buffer number
@@ -538,7 +540,7 @@ Lua module: vim.diagnostic *diagnostic-api*
• {namespace}? (`integer`) Limit diagnostics to the given namespace
• {scope}? (`'line'|'buffer'|'cursor'|'c'|'l'|'b'`, default:
`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
versions are also accepted (`c` for `cursor`, `l`
for `line`, `b` for `buffer`).
@@ -587,8 +589,6 @@ Lua module: vim.diagnostic *diagnostic-api*
Same as {prefix}, but appends the text to the
diagnostic instead of prepending it. Overrides the
setting from |vim.diagnostic.config()|.
• {focus_id}? (`string`)
• {border}? (`string`) see |nvim_open_win()|.
*vim.diagnostic.Opts.Jump*

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

@@ -109,7 +109,7 @@ end
--- @field signs vim.diagnostic.Opts.Signs
--- @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.
--- (default: current buffer)
@@ -118,7 +118,7 @@ end
--- Limit diagnostics to the given namespace
--- @field namespace? 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
--- are also accepted (`c` for `cursor`, `l` for `line`, `b` for `buffer`).
--- (default: `line`)
@@ -173,10 +173,6 @@ end
--- prepending it.
--- Overrides the setting from |vim.diagnostic.config()|.
--- @field suffix? string|table|(fun(diagnostic:vim.Diagnostic,i:integer,total:integer): string, string)
---
--- @field focus_id? string
---
--- @field border? string see |nvim_open_win()|.
--- @class vim.diagnostic.Opts.Underline
---