vim-patch:partial:c58f91c: runtime(doc): Whitespace updates (#36160)

Use double sentence spacing and wrap lines at 'textwidth'.  Code
examples and tables were not wrapped unless this had already been done
locally.

closes: vim/vim#18453

c58f91c035

Fix incorrect docs in :h ModeChanged.
Cherry-pick :h bufnr() changes from patch 8.1.2080.

Co-authored-by: Doug Kearns <dougkearns@gmail.com>
This commit is contained in:
zeertzjq
2025-10-13 16:53:21 +08:00
committed by GitHub
parent 7468db5187
commit a65202e6bd
51 changed files with 1541 additions and 1478 deletions

View File

@@ -570,8 +570,8 @@ vim.go.breakat = vim.o.breakat
vim.go.brk = vim.go.breakat
--- Every wrapped line will continue visually indented (same amount of
--- space as the beginning of that line), thus preserving horizontal blocks
--- of text.
--- space as the beginning of that line), thus preserving horizontal
--- blocks of text.
---
--- @type boolean
vim.o.breakindent = false
@@ -1073,12 +1073,12 @@ vim.bo.cms = vim.bo.commentstring
--- ] tag completion
--- t same as "]"
--- f scan the buffer names (as opposed to buffer contents)
--- F{func} call the function {func}. Multiple "F" flags may be specified.
--- Refer to `complete-functions` for details on how the function
--- is invoked and what it should return. The value can be the
--- name of a function or a `Funcref`. For `Funcref` values,
--- spaces must be escaped with a backslash ('\'), and commas with
--- double backslashes ('\\') (see `option-backslash`).
--- F{func} call the function {func}. Multiple "F" flags may be
--- specified. Refer to `complete-functions` for details on how
--- the function is invoked and what it should return. The value
--- can be the name of a function or a `Funcref`. For `Funcref`
--- values, spaces must be escaped with a backslash ('\'), and
--- commas with double backslashes ('\\') (see `option-backslash`).
--- Unlike other sources, functions can provide completions
--- starting from a non-keyword character before the cursor, and
--- their start position for replacing text may differ from other
@@ -1265,7 +1265,8 @@ vim.go.cot = vim.go.completeopt
--- completion in insert mode. This is useful when editing HTML tag, or
--- Makefile with 'noshellslash' on MS-Windows.
--- - When this option is set to "backslash", backslash is used. This is
--- useful when editing a batch file with 'shellslash' set on MS-Windows.
--- useful when editing a batch file with 'shellslash' set on
--- MS-Windows.
--- - When this option is empty, same character is used as for
--- 'shellslash'.
--- For Insert mode completion the buffer-local value is used. For
@@ -2959,7 +2960,6 @@ vim.wo.fdt = vim.wo.foldtext
--- modeline, see `sandbox-option`. That stops the option from working,
--- since changing the buffer text is not allowed.
--- This option cannot be set in a modeline when 'modelineexpr' is off.
--- NOTE: This option is set to "" when 'compatible' is set.
---
--- @type string
vim.o.formatexpr = ""
@@ -4000,9 +4000,9 @@ vim.o.lm = vim.o.langmenu
vim.go.langmenu = vim.o.langmenu
vim.go.lm = vim.go.langmenu
--- When off, setting 'langmap' does not apply to characters resulting from
--- a mapping. If setting 'langmap' disables some of your mappings, make
--- sure this option is off.
--- When off, setting 'langmap' does not apply to characters resulting
--- from a mapping. If setting 'langmap' disables some of your mappings,
--- make sure this option is off.
---
--- @type boolean
vim.o.langremap = false
@@ -4029,8 +4029,8 @@ vim.go.ls = vim.go.laststatus
--- executing macros, registers and other commands that have not been
--- typed. Also, updating the window title is postponed. To force an
--- update use `:redraw`.
--- This may occasionally cause display errors. It is only meant to be set
--- temporarily when performing an operation where redrawing may cause
--- This may occasionally cause display errors. It is only meant to be
--- set temporarily when performing an operation where redrawing may cause
--- flickering or cause a slowdown.
---
--- @type boolean
@@ -6433,9 +6433,6 @@ vim.wo.sms = vim.wo.smoothscroll
--- 'shiftwidth'. If you plan to use 'sts' and 'shiftwidth' with
--- different values, you might consider setting 'smarttab'.
---
--- 'softtabstop' is temporarily set to 0 when 'paste' is on and reset
--- when it is turned off. It is also reset when 'compatible' is set.
---
--- The 'L' flag in 'cpoptions' alters tab behavior when 'list' is
--- enabled. See also `ins-expandtab` ans user manual section `30.5` for
--- in-depth explanations.

File diff suppressed because it is too large Load Diff

View File

@@ -233,7 +233,7 @@ vim.v.exiting = ...
--- `json_encode()`. This value is converted to "v:false" when used
--- as a String (e.g. in `expr5` with string concatenation
--- operator) and to zero when used as a Number (e.g. in `expr5`
--- or `expr7` when used with numeric operators). Read-only.
--- or `expr7` when used with numeric operators). Read-only.
--- @type boolean
vim.v['false'] = ...
@@ -329,7 +329,7 @@ vim.v.foldlevel = ...
vim.v.foldstart = ...
--- Variable that indicates whether search highlighting is on.
--- Setting it makes sense only if 'hlsearch' is enabled. Setting
--- Setting it makes sense only if 'hlsearch' is enabled. Setting
--- this variable to zero acts like the `:nohlsearch` command,
--- setting it to one acts like
---
@@ -429,7 +429,7 @@ vim.v.msgpack_types = ...
--- See `json_encode()`. This value is converted to "v:null" when
--- used as a String (e.g. in `expr5` with string concatenation
--- operator) and to zero when used as a Number (e.g. in `expr5`
--- or `expr7` when used with numeric operators). Read-only.
--- or `expr7` when used with numeric operators). Read-only.
--- In some places `v:null` can be used for a List, Dict, etc.
--- that is not set. That is slightly different than an empty
--- List, Dict, etc.
@@ -479,7 +479,7 @@ vim.v.oldfiles = ...
--- @type string
vim.v.operator = ...
--- Command used to set the option. Valid while executing an
--- Command used to set the option. Valid while executing an
--- `OptionSet` autocommand.
--- value option was set via ~
--- "setlocal" `:setlocal` or `:let l:xxx`
@@ -489,30 +489,30 @@ vim.v.operator = ...
--- @type string
vim.v.option_command = ...
--- New value of the option. Valid while executing an `OptionSet`
--- New value of the option. Valid while executing an `OptionSet`
--- autocommand.
--- @type any
vim.v.option_new = ...
--- Old value of the option. Valid while executing an `OptionSet`
--- autocommand. Depending on the command used for setting and the
--- kind of option this is either the local old value or the
--- Old value of the option. Valid while executing an `OptionSet`
--- autocommand. Depending on the command used for setting and
--- the kind of option this is either the local old value or the
--- global old value.
--- @type any
vim.v.option_old = ...
--- Old global value of the option. Valid while executing an
--- Old global value of the option. Valid while executing an
--- `OptionSet` autocommand.
--- @type any
vim.v.option_oldglobal = ...
--- Old local value of the option. Valid while executing an
--- Old local value of the option. Valid while executing an
--- `OptionSet` autocommand.
--- @type any
vim.v.option_oldlocal = ...
--- Scope of the set command. Valid while executing an
--- `OptionSet` autocommand. Can be either "global" or "local"
--- Scope of the set command. Valid while executing an
--- `OptionSet` autocommand. Can be either "global" or "local"
--- @type string
vim.v.option_type = ...
@@ -752,7 +752,7 @@ vim.v.throwpoint = ...
--- `json_encode()`. This value is converted to "v:true" when used
--- as a String (e.g. in `expr5` with string concatenation
--- operator) and to one when used as a Number (e.g. in `expr5` or
--- `expr7` when used with numeric operators). Read-only.
--- `expr7` when used with numeric operators). Read-only.
--- @type boolean
vim.v['true'] = ...