mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-11-23 10:36:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(lsp): Fix opts param not captured by docgen

Browse Source 
In the documentation for `vim.lsp.util.open_floating_preview`
the opts table keys were prefixed with `--` instead of `---`,
preventing capture by docgen.
This commit is contained in:
shadmansaleh
2021-06-01 13:34:37 +06:00
parent 0bd34cb4ec
commit 68d48e25b6
2 changed files with 35 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
runtime/lua/vim/lsp/util.lua
View File

@@ -1305,19 +1305,19 @@ end
--@param contents table of lines to show in window
--@param syntax string of syntax to set for opened buffer
--@param opts dictionary with optional fields
-- - height of floating window
-- - width of floating window
-- - wrap boolean enable wrapping of long lines (defaults to true)
-- - wrap_at character to wrap at for computing height when wrap is enabled
-- - max_width maximal width of floating window
-- - max_height maximal height of floating window
-- - pad_left number of columns to pad contents at left
-- - pad_right number of columns to pad contents at right
-- - pad_top number of lines to pad contents at top
-- - pad_bottom number of lines to pad contents at bottom
-- - focus_id if a popup with this id is opened, then focus it
-- - close_events list of events that closes the floating window
-- - focusable (boolean, default true): Make float focusable
--- - height of floating window
--- - width of floating window
--- - wrap boolean enable wrapping of long lines (defaults to true)
--- - wrap_at character to wrap at for computing height when wrap is enabled
--- - max_width maximal width of floating window
--- - max_height maximal height of floating window
--- - pad_left number of columns to pad contents at left
--- - pad_right number of columns to pad contents at right
--- - pad_top number of lines to pad contents at top
--- - pad_bottom number of lines to pad contents at bottom
--- - focus_id if a popup with this id is opened, then focus it
--- - close_events list of events that closes the floating window
--- - focusable (boolean, default true): Make float focusable
--@returns bufnr,winnr buffer and window number of the newly created floating
---preview window
function M.open_floating_preview(contents, syntax, opts)