vim-patch:af58a9f: runtime(doc): adjust :h 'autowrite' and :h 'autowriteall'

- Don't go over 78 columns.
- Change the first "and" to "or", as "or" is used below.
- Change "takes one" to "switches", as "one" may be mistaken as
  referring to the command instead of the user.
- Use backticks in :h 'autowriteall' like in :h 'autowrite'.

closes: vim/vim#19859

af58a9f5e9
This commit is contained in:
zeertzjq
2026-04-03 22:29:45 +08:00
parent 76a917a81e
commit 20e46cb38d
3 changed files with 18 additions and 18 deletions

View File

@@ -822,10 +822,10 @@ A jump table for the options with a short description can be found at |Q_op|.
'autowrite' 'aw' boolean (default off)
global
Write the contents of the file, if it has been modified, on each
`:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
`:suspend`, `:tag`, `:!`, `:make`, `:terminal`, CTRL-] and CTRL-^ command; and when
a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
to another file.
`:next`, `:rewind`, `:last`, `:first`, `:previous`, `:tag`, `:stop`,
`:suspend`, `:!`, `:make`, `:terminal`, CTRL-] or CTRL-^ command; and
when a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command
switches to another file.
A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
set to "hide" and `:next` is used.
Note that for some commands the 'autowrite' option is not used, see
@@ -839,8 +839,8 @@ A jump table for the options with a short description can be found at |Q_op|.
*'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
'autowriteall' 'awa' boolean (default off)
global
Like 'autowrite', but also used for commands ":edit", ":enew",
":quit", ":qall", ":exit", ":xit", ":recover" and closing the Vim
Like 'autowrite', but also used for commands `:edit`, `:enew`,
`:quit`, `:qall`, `:exit`, `:xit`, `:recover` and closing the Vim
window.
Setting this option also implies that Vim behaves like 'autowrite' has
been set.

View File

@@ -189,10 +189,10 @@ vim.go.autoread = vim.o.autoread
vim.go.ar = vim.go.autoread
--- Write the contents of the file, if it has been modified, on each
--- `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
--- `:suspend`, `:tag`, `:!`, `:make`, `:terminal`, CTRL-] and CTRL-^ command; and when
--- a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
--- to another file.
--- `:next`, `:rewind`, `:last`, `:first`, `:previous`, `:tag`, `:stop`,
--- `:suspend`, `:!`, `:make`, `:terminal`, CTRL-] or CTRL-^ command; and
--- when a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command
--- switches to another file.
--- A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
--- set to "hide" and `:next` is used.
--- Note that for some commands the 'autowrite' option is not used, see
@@ -209,8 +209,8 @@ vim.o.aw = vim.o.autowrite
vim.go.autowrite = vim.o.autowrite
vim.go.aw = vim.go.autowrite
--- Like 'autowrite', but also used for commands ":edit", ":enew",
--- ":quit", ":qall", ":exit", ":xit", ":recover" and closing the Vim
--- Like 'autowrite', but also used for commands `:edit`, `:enew`,
--- `:quit`, `:qall`, `:exit`, `:xit`, `:recover` and closing the Vim
--- window.
--- Setting this option also implies that Vim behaves like 'autowrite' has
--- been set.

View File

@@ -323,10 +323,10 @@ local options = {
defaults = false,
desc = [=[
Write the contents of the file, if it has been modified, on each
`:next`, `:rewind`, `:last`, `:first`, `:previous`, `:stop`,
`:suspend`, `:tag`, `:!`, `:make`, `:terminal`, CTRL-] and CTRL-^ command; and when
a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command takes one
to another file.
`:next`, `:rewind`, `:last`, `:first`, `:previous`, `:tag`, `:stop`,
`:suspend`, `:!`, `:make`, `:terminal`, CTRL-] or CTRL-^ command; and
when a `:buffer`, CTRL-O, CTRL-I, '{A-Z0-9}, or `{A-Z0-9} command
switches to another file.
A buffer is not written if it becomes hidden, e.g. when 'bufhidden' is
set to "hide" and `:next` is used.
Note that for some commands the 'autowrite' option is not used, see
@@ -347,8 +347,8 @@ local options = {
abbreviation = 'awa',
defaults = false,
desc = [=[
Like 'autowrite', but also used for commands ":edit", ":enew",
":quit", ":qall", ":exit", ":xit", ":recover" and closing the Vim
Like 'autowrite', but also used for commands `:edit`, `:enew`,
`:quit`, `:qall`, `:exit`, `:xit`, `:recover` and closing the Vim
window.
Setting this option also implies that Vim behaves like 'autowrite' has
been set.