aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim/_meta
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2026-05-30 07:35:05 -0400
committerGitHub <noreply@github.com>2026-05-30 07:35:05 -0400
commita9ef07681796f68324c59cd110f429247e142d1b (patch)
tree5ac952bcfef2f6d39cae1b2953ed8dc83164e04c /runtime/lua/vim/_meta
parent6b799ee40a5729b6b2c7264b3987d1abf16839b6 (diff)
parentf5fae7aa5cf1e599b2bbc0ef0ae6deccc8c0b3d5 (diff)
downloadrneovim-a9ef07681796f68324c59cd110f429247e142d1b.tar.gz
rneovim-a9ef07681796f68324c59cd110f429247e142d1b.tar.bz2
rneovim-a9ef07681796f68324c59cd110f429247e142d1b.zip
Merge #39908 from justinmk/doc2
docs: misc
Diffstat (limited to 'runtime/lua/vim/_meta')
-rw-r--r--runtime/lua/vim/_meta/api.gen.lua11
-rw-r--r--runtime/lua/vim/_meta/options.gen.lua15
2 files changed, 12 insertions, 14 deletions
diff --git a/runtime/lua/vim/_meta/api.gen.lua b/runtime/lua/vim/_meta/api.gen.lua
index e5648706da..c055b859bc 100644
--- a/runtime/lua/vim/_meta/api.gen.lua
+++ b/runtime/lua/vim/_meta/api.gen.lua
@@ -1852,8 +1852,7 @@ function vim.api.nvim_open_term(buf, opts) end
--- Value can be one of "left", "center", or "right".
--- Default is `"left"`.
--- - height: Window height (in character cells). Minimum of 1.
---- - hide: If true the floating window will be hidden and the cursor will be invisible when
---- focused on it.
+--- - hide: Hides the floating window. `window-hidden`
--- - mouse: Specify how this window interacts with mouse events.
--- Defaults to `focusable` value.
--- - If false, mouse events pass through this window.
@@ -2514,12 +2513,10 @@ function vim.api.nvim_win_get_var(win, name) end
--- @return integer # Width as a count of columns
function vim.api.nvim_win_get_width(win) end
---- Closes the window and hide the buffer it contains (like `:hide` with a
---- `window-ID`).
+--- Closes the window and hides the buffer it contains (like `:hide` with a `window-ID`; unrelated
+--- to the `hide` flag of `nvim_open_win()`, `nvim_win_get_config()`).
---
---- Like `:hide` the buffer becomes hidden unless another window is editing it,
---- or 'bufhidden' is `unload`, `delete` or `wipe` as opposed to `:close` or
---- `nvim_win_close()`, which will close the buffer.
+--- Compare `:close` and `nvim_win_close()`, which close the buffer instead of hiding it.
---
--- @param win integer `window-ID`, or 0 for current window
function vim.api.nvim_win_hide(win) end
diff --git a/runtime/lua/vim/_meta/options.gen.lua b/runtime/lua/vim/_meta/options.gen.lua
index fefc7d7eb7..520abbd8a6 100644
--- a/runtime/lua/vim/_meta/options.gen.lua
+++ b/runtime/lua/vim/_meta/options.gen.lua
@@ -652,14 +652,15 @@ vim.bo.buflisted = vim.o.buflisted
vim.bo.bl = vim.bo.buflisted
--- The value of this option specifies the type of a buffer:
---- <empty> normal buffer
---- acwrite buffer will always be written with `BufWriteCmd`s
---- help help buffer (do not set this manually)
---- nofile buffer is not related to a file, will not be written
---- nowrite buffer will not be written
---- prompt buffer where only the last section can be edited, for
+--- (empty) Normal buffer.
+--- acwrite Buffer will always be written with `BufWriteCmd`.
+--- help Help buffer (do not set this manually).
+--- nofile Buffer is not a file, will not be written.
+--- nowrite Buffer represents a filepath (such as a directory),
+--- but will not be written.
+--- prompt Buffer where only the last section can be edited, for
--- use by plugins. `prompt-buffer`
---- quickfix list of errors `:cwindow` or locations `:lwindow`
+--- quickfix List of errors `:cwindow` or locations `:lwindow`
--- terminal `terminal-emulator` buffer
---
--- This option is used together with 'bufhidden' and 'swapfile' to