aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim/_meta/api.lua
diff options
context:
space:
mode:
Diffstat (limited to 'runtime/lua/vim/_meta/api.lua')
-rw-r--r--runtime/lua/vim/_meta/api.lua17
1 files changed, 12 insertions, 5 deletions
diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index fdf5016b68..7704a60cf8 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -1551,11 +1551,18 @@ function vim.api.nvim_open_term(buffer, opts) end
--- specified by character: [ ["+", "MyCorner"], ["x",
--- "MyBorder"] ].
---
---- • title: Title (optional) in window border, String or list.
---- List is [text, highlight] tuples. if is string the default
---- highlight group is `FloatTitle`.
---- • title_pos: Title position must set with title option.
---- value can be of `left` `center` `right` default is left.
+--- • title: Title (optional) in window border, string or list.
+--- List should consist of `[text, highlight]` tuples. If
+--- string, the default highlight group is `FloatTitle`.
+--- • title_pos: Title position. Must be set with `title`
+--- option. Value can be one of "left", "center", or "right".
+--- Default is `"left"`.
+--- • footer: Footer (optional) in window border, string or
+--- list. List should consist of `[text, highlight]` tuples.
+--- If string, the default highlight group is `FloatTitle`.
+--- • footer_pos: Footer position. Must be set with `footer`
+--- option. Value can be one of "left", "center", or "right".
+--- Default is `"left"`.
--- • noautocmd: If true then no buffer-related autocommand
--- events such as `BufEnter`, `BufLeave` or `BufWinEnter` may
--- fire from calling this function.