vim-patch:0049a495c8d4 (#27817)

runtime(doc): improve 'winfixbuf' docs (vim/vim#14180)

- Make it not sound like a buffer option.
- "!" is called a modifier, not an option.

0049a495c8
This commit is contained in:
zeertzjq 2024-03-12 05:39:21 +08:00 committed by GitHub
parent 205cf0d296
commit 9cc755ad6a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 10 additions and 9 deletions

View File

@ -270,6 +270,7 @@ created, thus they behave slightly differently:
Option Reason ~ Option Reason ~
'previewwindow' there can only be a single one 'previewwindow' there can only be a single one
'scroll' specific to existing window 'scroll' specific to existing window
'winfixbuf' specific to existing window
'winfixheight' specific to existing window 'winfixheight' specific to existing window
'winfixwidth' specific to existing window 'winfixwidth' specific to existing window
@ -7175,11 +7176,11 @@ A jump table for the options with a short description can be found at |Q_op|.
*'winfixbuf'* *'wfb'* *'nowinfixbuf'* *'nowfb'* *'winfixbuf'* *'wfb'* *'nowinfixbuf'* *'nowfb'*
'winfixbuf' 'wfb' boolean (default off) 'winfixbuf' 'wfb' boolean (default off)
local to window local to window
If enabled, the buffer and any window that displays it are paired. If enabled, the window and the buffer it is displaying are paired.
For example, attempting to change the buffer with |:edit| will fail. For example, attempting to change the buffer with |:edit| will fail.
Other commands which change a window's buffer such as |:cnext| will Other commands which change a window's buffer such as |:cnext| will
also skip any window with 'winfixbuf' enabled. However if a command also skip any window with 'winfixbuf' enabled. However if an Ex
has an "!" option, a window can be forced to switch buffers. command has a "!" modifier, it can force switching buffers.
*'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'* *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
'winfixheight' 'wfh' boolean (default off) 'winfixheight' 'wfh' boolean (default off)

View File

@ -7876,11 +7876,11 @@ vim.o.wi = vim.o.window
vim.go.window = vim.o.window vim.go.window = vim.o.window
vim.go.wi = vim.go.window vim.go.wi = vim.go.window
--- If enabled, the buffer and any window that displays it are paired. --- If enabled, the window and the buffer it is displaying are paired.
--- For example, attempting to change the buffer with `:edit` will fail. --- For example, attempting to change the buffer with `:edit` will fail.
--- Other commands which change a window's buffer such as `:cnext` will --- Other commands which change a window's buffer such as `:cnext` will
--- also skip any window with 'winfixbuf' enabled. However if a command --- also skip any window with 'winfixbuf' enabled. However if an Ex
--- has an "!" option, a window can be forced to switch buffers. --- command has a "!" modifier, it can force switching buffers.
--- ---
--- @type boolean --- @type boolean
vim.o.winfixbuf = false vim.o.winfixbuf = false

View File

@ -9822,11 +9822,11 @@ return {
abbreviation = 'wfb', abbreviation = 'wfb',
defaults = { if_true = false }, defaults = { if_true = false },
desc = [=[ desc = [=[
If enabled, the buffer and any window that displays it are paired. If enabled, the window and the buffer it is displaying are paired.
For example, attempting to change the buffer with |:edit| will fail. For example, attempting to change the buffer with |:edit| will fail.
Other commands which change a window's buffer such as |:cnext| will Other commands which change a window's buffer such as |:cnext| will
also skip any window with 'winfixbuf' enabled. However if a command also skip any window with 'winfixbuf' enabled. However if an Ex
has an "!" option, a window can be forced to switch buffers. command has a "!" modifier, it can force switching buffers.
]=], ]=],
full_name = 'winfixbuf', full_name = 'winfixbuf',
pv_name = 'p_wfb', pv_name = 'p_wfb',