Incomplete Documentation for vim.diagnostic.open_float Options

[kyoh86]

Problem

The documentation for vim.diagnostic.open_float appears to be incomplete or incorrectly formatted.
The option descriptions seem to be truncated or missing some fields.

Additionally, some relevant options such as focus_id and focusable are missing but are present in the vim.lsp.util.open_floating_preview.
It is unclear whether these options are intended to be supported by vim.diagnostic.open_float or not.

Note: I found that we can call vim.diagnostic.open_float({focusable=true}) and observe that it behaves similarly to vim.lsp.buf.hover(), allowing focus to be set on the floating window with a second call.

Steps to reproduce

1. Open Neovim.
2. Execute :help vim.diagnostic.open_float to view the help documentation.
3. Observe the incomplete descriptions for the options.

Expected behavior

We can understand right behaviors and options of vim.diagnostic.open_float.

Neovim version (nvim -v)

NVIM v0.11.0-dev-78d3f47

Vim (not Nvim) behaves the same?

no

Operating system/version

Arch Linux

Terminal name/version

WezTerm

$TERM environment variable

xterm-256color

Installation

build from repo

[kyoh86]

It's not about a vim.diagnostic.open_float but a vim.diagnostic.Opts.Float

[justinmk]

in other words, :help vim.diagnostic.Opts.Float is missing some fields available on :help nvim_open_win() ?

[kyoh86]

We could say that, but I cannot determine where it is written correctly.