aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim/lsp/util.lua
diff options
context:
space:
mode:
authorzeertzjq <zeertzjq@outlook.com>2021-10-03 08:55:54 +0800
committerGitHub <noreply@github.com>2021-10-02 17:55:54 -0700
commit4449297d12b70f5e6a65365e39aacf5e42303ffd (patch)
treeb8b8f4341025e58be73d28960ff0a5bf2ed5a69c /runtime/lua/vim/lsp/util.lua
parentb3e815094bad6c28b758bc7538bf1b13936660fc (diff)
downloadrneovim-4449297d12b70f5e6a65365e39aacf5e42303ffd.tar.gz
rneovim-4449297d12b70f5e6a65365e39aacf5e42303ffd.tar.bz2
rneovim-4449297d12b70f5e6a65365e39aacf5e42303ffd.zip
docs(lsp): clarify parameters of some util functions (#15851)
`pad_left` and `pad_right` are unused List used keys of `opts` in `make_floating_popup_options`
Diffstat (limited to 'runtime/lua/vim/lsp/util.lua')
-rw-r--r--runtime/lua/vim/lsp/util.lua9
1 files changed, 5 insertions, 4 deletions
diff --git a/runtime/lua/vim/lsp/util.lua b/runtime/lua/vim/lsp/util.lua
index 09d0a8e62a..fca956fb57 100644
--- a/runtime/lua/vim/lsp/util.lua
+++ b/runtime/lua/vim/lsp/util.lua
@@ -951,6 +951,11 @@ end
---@param width (number) window width (in character cells)
---@param height (number) window height (in character cells)
---@param opts (table, optional)
+--- - offset_x (number) offset to add to `col`
+--- - offset_y (number) offset to add to `row`
+--- - border (string or table) override `border`
+--- - focusable (string or table) override `focusable`
+--- - zindex (string or table) override `zindex`, defaults to 50
---@returns (table) Options
function M.make_floating_popup_options(width, height, opts)
validate {
@@ -1124,8 +1129,6 @@ end
--- - wrap_at character to wrap at for computing height
--- - 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
--- - separator insert separator after code block
@@ -1376,8 +1379,6 @@ end
--- - 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