diff options
| author | shadmansaleh <shadmansaleh3@gmail.com> | 2021-06-01 13:34:37 +0600 |
|---|---|---|
| committer | shadmansaleh <shadmansaleh3@gmail.com> | 2021-06-01 17:29:06 +0600 |
| commit | 68d48e25b6d6e8d9b06c557cbf9b018c3e84ab72 (patch) | |
| tree | b1ada69e5ae369c96f451553ec7360e16b768d6c /runtime/lua/vim/lsp/util.lua | |
| parent | 0bd34cb4ec301abeb751f8d3be1d3b644a009355 (diff) | |
| download | rneovim-68d48e25b6d6e8d9b06c557cbf9b018c3e84ab72.tar.gz rneovim-68d48e25b6d6e8d9b06c557cbf9b018c3e84ab72.tar.bz2 rneovim-68d48e25b6d6e8d9b06c557cbf9b018c3e84ab72.zip | |
docs(lsp): Fix opts param not captured by docgen
In the documentation for `vim.lsp.util.open_floating_preview`
the opts table keys were prefixed with `--` instead of `---`,
preventing capture by docgen.
Diffstat (limited to 'runtime/lua/vim/lsp/util.lua')
| -rw-r--r-- | runtime/lua/vim/lsp/util.lua | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua index 04f99112bf..8616a9ef3b 100644 --- a/runtime/lua/vim/lsp/util.lua +++ b/runtime/lua/vim/lsp/util.lua @@ -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) |