summaryrefslogtreecommitdiffstatshomepage
path: root/runtime/lua/vim/_meta/api.lua
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2026-02-12 14:16:47 +0100
committerJustin M. Keyes <justinkz@gmail.com>2026-03-11 18:00:18 +0100
commitb8a976afdaf0080498e85530fae65a3165f201d5 (patch)
treedf9889722d148f6d97f3821264a7c0255d5bee8b /runtime/lua/vim/_meta/api.lua
parent4aeeaa80273eda1cf4fdb5de4b8ea65a16cefbaf (diff)
docs: api, messages, lsp, trust
gen_vimdoc.lua: In prepare for the upcoming release, comment-out the "Experimental" warning for prerelease features.
Diffstat (limited to 'runtime/lua/vim/_meta/api.lua')
-rw-r--r--runtime/lua/vim/_meta/api.lua39
1 files changed, 16 insertions, 23 deletions
diff --git a/runtime/lua/vim/_meta/api.lua b/runtime/lua/vim/_meta/api.lua
index 9b7bec6678..ff05e0a332 100644
--- a/runtime/lua/vim/_meta/api.lua
+++ b/runtime/lua/vim/_meta/api.lua
@@ -1703,26 +1703,19 @@ function vim.api.nvim_notify(msg, log_level, opts) end
--- @return integer # Channel id, or 0 on error
function vim.api.nvim_open_term(buffer, opts) end
---- Opens a new split window, or a floating window if `relative` is specified,
---- or an external window (managed by the UI) if `external` is specified.
+--- Opens a new split window, floating window, or external window.
---
---- Floats are windows that are drawn above the split layout, at some anchor
---- position in some other window. Floats can be drawn internally or by external
---- GUI with the `ui-multigrid` extension. External windows are only supported
---- with multigrid GUIs, and are displayed as separate top-level windows.
----
---- For a general overview of floats, see `api-floatwin`.
----
---- The `width` and `height` of the new window must be specified when opening
---- a floating window, but are optional for normal windows.
----
---- If `relative` and `external` are omitted, a normal "split" window is created.
---- The `win` property determines which window will be split. If no `win` is
---- provided or `win == 0`, a window will be created adjacent to the current window.
---- If -1 is provided, a top-level split will be created. `vertical` and `split` are
---- only valid for normal windows, and are used to control split direction. For `vertical`,
---- the exact direction is determined by 'splitright' and 'splitbelow'.
---- Split windows cannot have `bufpos`, `row`, `col`, `border`, `title`, `footer` properties.
+--- - Specify `relative` to create a floating window. Floats are drawn over the split layout,
+--- relative to a position in some other window. See `api-floatwin`.
+--- - Floats must specify `width` and `height`.
+--- - Specify `external` to create an external window. External windows are displayed as separate
+--- top-level windows managed by the `ui-multigrid` UI (not Nvim).
+--- - If `relative` and `external` are omitted, a normal "split" window is created.
+--- - The `win` key decides which window to split. If nil or 0, the split will be adjacent to
+--- the current window. If -1, a top-level split will be created.
+--- - Use `vertical` and `split` to control split direction. For `vertical`, the exact direction
+--- is determined by 'splitright' and 'splitbelow'.
+--- - Split windows cannot have `bufpos`, `row`, `col`, `border`, `title`, `footer`.
---
--- With relative=editor (row=0,col=0) refers to the top-left corner of the
--- screen-grid and (row=Lines-1,col=Columns-1) refers to the bottom-right
@@ -2492,11 +2485,11 @@ function vim.api.nvim_win_is_valid(window) end
--- @param buffer integer Buffer id
function vim.api.nvim_win_set_buf(window, buffer) end
---- Reconfigures the layout of a window.
+--- Reconfigures the layout and properties of a window.
---
---- - Absent (`nil`) keys will not be changed.
---- - `row` / `col` / `relative` must be reconfigured together.
---- - Cannot be used to move the last window in a tabpage to a different one.
+--- - Updates only the given keys; unspecified (`nil`) keys will not be changed.
+--- - Keys `row` / `col` / `relative` must be specified together.
+--- - Cannot move the last window in a tabpage to a different one.
---
--- Example: to convert a floating window to a "normal" split window, specify the `win` field:
---