docs: misc

This commit is contained in:
Justin M. Keyes
2026-03-14 22:18:08 +01:00
parent b8f1426a86
commit ca67ba3b66
9 changed files with 81 additions and 64 deletions

View File

@@ -2507,6 +2507,8 @@ function vim.api.nvim_win_set_buf(window, buffer) end
--- Reconfigures the layout and properties of a window.
---
--- - Updates only the given keys; unspecified (`nil`) keys will not be changed.
--- - Can move a window to another tabpage.
--- - Can transform a window to/from a float.
--- - Keys `row` / `col` / `relative` must be specified together.
--- - Cannot move the last window in a tabpage to a different one.
---

View File

@@ -7479,10 +7479,14 @@ vim.o.tm = vim.o.timeoutlen
vim.go.timeoutlen = vim.o.timeoutlen
vim.go.tm = vim.go.timeoutlen
--- When on, the title of the window will be set to the value of
--- 'titlestring' (if it is not empty), or to:
--- If enabled, Nvim will update the (GUI or terminal) window title. The
--- format is configured by 'titlestring'. By default it looks like:
--- ```
--- filename [+=-] (path) - Nvim
--- Where:
--- ```
---
--- where:
--- ```
--- filename the name of the file being edited
--- - indicates the file cannot be modified, 'ma' off
--- + indicates the file was modified
@@ -7490,6 +7494,8 @@ vim.go.tm = vim.go.timeoutlen
--- =+ indicates the file is read-only and modified
--- (path) is the path of the file being edited
--- - Nvim the server name `v:servername` or "Nvim"
--- ```
---
---
--- @type boolean
vim.o.title = false
@@ -7518,41 +7524,41 @@ vim.go.titlelen = vim.o.titlelen
vim.o.titleold = ""
vim.go.titleold = vim.o.titleold
--- When this option is not empty, it will be used for the title of the
--- window. This happens only when the 'title' option is on.
--- Formats the window title, enabled by the 'title' option.
---
--- When this option contains printf-style '%' items, they will be
--- expanded according to the rules used for 'statusline'. If it contains
--- an invalid '%' format, the value is used as-is and no error or warning
--- will be given when the value is set.
--- Contains printf-style "%" items, expanded according to the rules of
--- 'statusline'. If a "%" format is invalid, it is used as-is and no
--- error will be given.
---
--- The default behaviour is equivalent to:
--- The default (empty) behaviour is equivalent to:
---
--- ```vim
--- set titlestring=%t%(\ %M%)%(\ \(%{expand(\"%:~:h\")}\)%)%a\ -\ Nvim
--- ```
---
--- This option cannot be set in a modeline when 'modelineexpr' is off.
---
--- Example:
---
--- ```vim
--- auto BufEnter * let &titlestring = hostname() .. "/" .. expand("%:p")
--- set title titlestring=%<%F%=%l/%L-%P titlelen=70
--- ```
--- The value of 'titlelen' is used to align items in the middle or right
--- of the available space.
--- Some people prefer to have the file name first:
--- The value of 'titlelen' is used to align items in the middle
--- or right of the available space.
---
--- Example: to have the file name first:
---
--- ```vim
--- set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
--- ```
--- Note the use of "%{ }" and an expression to get the path of the file,
--- without the file name. The "%( %)" constructs are used to add a
--- Note the use of "%{ }" and an expression to get the path of
--- the file, without the file name. The "%( %)" constructs add a
--- separating space only when needed.
---
--- NOTE: Use of special characters in 'titlestring' may cause the display
--- to be garbled (e.g., when it contains a CR or NL character).
---
--- This option cannot be set in a modeline when 'modelineexpr' is off.
---
--- @type string
vim.o.titlestring = ""
vim.go.titlestring = vim.o.titlestring