mirror of
https://github.com/neovim/neovim.git
synced 2025-12-16 03:15:39 +00:00
vim-patch:partial:235e77a: runtime(doc): Tweak documentation style more in options and ft_hare (#35761)
closes: 18289
235e77a3a3
Skip ft_hare.txt.
Co-authored-by: Hirohito Higashi <h.east.727@gmail.com>
This commit is contained in:
zeertzjq
50
runtime/lua/vim/_meta/options.lua
generated
50
runtime/lua/vim/_meta/options.lua
generated
@@ -377,7 +377,7 @@ vim.go.bkc = vim.go.backupcopy
|
||||
--- - A directory name may end in an '/'.
|
||||
--- - For Unix and Win32, if a directory ends in two path separators "//",
|
||||
--- the swap file name will be built from the complete path to the file
|
||||
--- with all path separators changed to percent '%' signs. This will
|
||||
--- with all path separators changed to percent '%' signs. This will
|
||||
--- ensure file name uniqueness in the backup directory.
|
||||
--- On Win32, it is also possible to end with "\\". However, When a
|
||||
--- separating comma is following, you must use "//", since "\\" will
|
||||
@@ -462,10 +462,10 @@ vim.o.bsk = vim.o.backupskip
|
||||
vim.go.backupskip = vim.o.backupskip
|
||||
vim.go.bsk = vim.go.backupskip
|
||||
|
||||
--- Specifies for which events the bell will not be rung. It is a comma-
|
||||
--- separated list of items. For each item that is present, the bell
|
||||
--- will be silenced. This is most useful to specify specific events in
|
||||
--- insert mode to be silenced.
|
||||
--- Specifies for which events the bell will not be rung. It is a comma-
|
||||
--- separated list of items. For each item that is present, the bell will
|
||||
--- be silenced. This is most useful to specify specific events in insert
|
||||
--- mode to be silenced.
|
||||
--- You can also make it flash by using 'visualbell'.
|
||||
---
|
||||
--- item meaning when present ~
|
||||
@@ -495,8 +495,8 @@ vim.go.bsk = vim.go.backupskip
|
||||
--- (depends on the 'wildmode' setting).
|
||||
---
|
||||
--- This is most useful to fine tune when in Insert mode the bell should
|
||||
--- be rung. For Normal mode and Ex commands, the bell is often rung to
|
||||
--- indicate that an error occurred. It can be silenced by adding the
|
||||
--- be rung. For Normal mode and Ex commands, the bell is often rung to
|
||||
--- indicate that an error occurred. It can be silenced by adding the
|
||||
--- "error" keyword.
|
||||
---
|
||||
--- @type string
|
||||
@@ -577,11 +577,11 @@ vim.o.bri = vim.o.breakindent
|
||||
vim.wo.breakindent = vim.o.breakindent
|
||||
vim.wo.bri = vim.wo.breakindent
|
||||
|
||||
--- Settings for 'breakindent'. It can consist of the following optional
|
||||
--- Settings for 'breakindent'. It can consist of the following optional
|
||||
--- items and must be separated by a comma:
|
||||
--- min:{n} Minimum text width that will be kept after
|
||||
--- applying 'breakindent', even if the resulting
|
||||
--- text should normally be narrower. This prevents
|
||||
--- text should normally be narrower. This prevents
|
||||
--- text indented almost to the right window border
|
||||
--- occupying lots of vertical space when broken.
|
||||
--- (default: 20)
|
||||
@@ -600,8 +600,8 @@ vim.wo.bri = vim.wo.breakindent
|
||||
--- (default: 0)
|
||||
--- list:-1 Uses the width of a match with 'formatlistpat' for
|
||||
--- indentation.
|
||||
--- column:{n} Indent at column {n}. Will overrule the other
|
||||
--- sub-options. Note: an additional indent may be
|
||||
--- column:{n} Indent at column {n}. Will overrule the other
|
||||
--- sub-options. Note: an additional indent may be
|
||||
--- added for the 'showbreak' setting.
|
||||
--- (default: off)
|
||||
---
|
||||
@@ -824,7 +824,7 @@ vim.bo.channel = vim.o.channel
|
||||
--- faster, see `expr-option-function`.
|
||||
---
|
||||
--- If the 'charconvert' expression starts with s: or `<SID>`, then it is
|
||||
--- replaced with the script ID (`local-function`). Example:
|
||||
--- replaced with the script ID (`local-function`). Example:
|
||||
---
|
||||
--- ```vim
|
||||
--- set charconvert=s:MyConvert()
|
||||
@@ -1119,7 +1119,7 @@ vim.bo.cpt = vim.bo.complete
|
||||
--- with CTRL-X CTRL-U. `i_CTRL-X_CTRL-U`
|
||||
--- See `complete-functions` for an explanation of how the function is
|
||||
--- invoked and what it should return. The value can be the name of a
|
||||
--- function, a `lambda` or a `Funcref`. See `option-value-function` for
|
||||
--- function, a `lambda` or a `Funcref`. See `option-value-function` for
|
||||
--- more information.
|
||||
--- This option cannot be set from a `modeline` or in the `sandbox`, for
|
||||
--- security reasons.
|
||||
@@ -1235,7 +1235,7 @@ vim.go.cia = vim.go.completeitemalign
|
||||
--- Only "fuzzy", "popup", "preinsert" and "preview" have an effect when
|
||||
--- 'autocomplete' is enabled.
|
||||
---
|
||||
--- This option does not apply to `cmdline-completion`. See 'wildoptions'
|
||||
--- This option does not apply to `cmdline-completion`. See 'wildoptions'
|
||||
--- for that.
|
||||
---
|
||||
--- @type string
|
||||
@@ -1968,7 +1968,7 @@ vim.go.dg = vim.go.digraph
|
||||
--- - For Unix and Win32, if a directory ends in two path separators "//",
|
||||
--- the swap file name will be built from the complete path to the file
|
||||
--- with all path separators replaced by percent '%' signs (including
|
||||
--- the colon following the drive letter on Win32). This will ensure
|
||||
--- the colon following the drive letter on Win32). This will ensure
|
||||
--- file name uniqueness in the preserve directory.
|
||||
--- On Win32, it is also possible to end with "\\". However, When a
|
||||
--- separating comma is following, you must use "//", since "\\" will
|
||||
@@ -2923,7 +2923,7 @@ vim.wo.fdt = vim.wo.foldtext
|
||||
--- the internal format mechanism.
|
||||
---
|
||||
--- If the expression starts with s: or `<SID>`, then it is replaced with
|
||||
--- the script ID (`local-function`). Example:
|
||||
--- the script ID (`local-function`). Example:
|
||||
---
|
||||
--- ```vim
|
||||
--- set formatexpr=s:MyFormatExpr()
|
||||
@@ -3516,7 +3516,7 @@ vim.go.inc = vim.go.include
|
||||
--- Note: Not used for `<cfile>`.
|
||||
---
|
||||
--- If the expression starts with s: or `<SID>`, then it is replaced with
|
||||
--- the script ID (`local-function`). Example:
|
||||
--- the script ID (`local-function`). Example:
|
||||
---
|
||||
--- ```vim
|
||||
--- setlocal includeexpr=s:MyIncludeExpr()
|
||||
@@ -3593,7 +3593,7 @@ vim.go.is = vim.go.incsearch
|
||||
--- when the expression is evaluated (but it may be moved around).
|
||||
---
|
||||
--- If the expression starts with s: or `<SID>`, then it is replaced with
|
||||
--- the script ID (`local-function`). Example:
|
||||
--- the script ID (`local-function`). Example:
|
||||
---
|
||||
--- ```vim
|
||||
--- set indentexpr=s:MyIndentExpr()
|
||||
@@ -4879,7 +4879,7 @@ vim.wo.nuw = vim.wo.numberwidth
|
||||
--- completion with CTRL-X CTRL-O. `i_CTRL-X_CTRL-O`
|
||||
--- See `complete-functions` for an explanation of how the function is
|
||||
--- invoked and what it should return. The value can be the name of a
|
||||
--- function, a `lambda` or a `Funcref`. See `option-value-function` for
|
||||
--- function, a `lambda` or a `Funcref`. See `option-value-function` for
|
||||
--- more information.
|
||||
--- This option is usually set by a filetype plugin:
|
||||
--- `:filetype-plugin-on`
|
||||
@@ -4894,7 +4894,7 @@ vim.bo.ofu = vim.bo.omnifunc
|
||||
|
||||
--- This option specifies a function to be called by the `g@` operator.
|
||||
--- See `:map-operator` for more info and an example. The value can be
|
||||
--- the name of a function, a `lambda` or a `Funcref`. See
|
||||
--- the name of a function, a `lambda` or a `Funcref`. See
|
||||
--- `option-value-function` for more information.
|
||||
---
|
||||
--- This option cannot be set from a `modeline` or in the `sandbox`, for
|
||||
@@ -5157,7 +5157,7 @@ vim.go.pyx = vim.go.pyxversion
|
||||
--- for each entry in the corresponding quickfix or location list. See
|
||||
--- `quickfix-window-function` for an explanation of how to write the
|
||||
--- function and an example. The value can be the name of a function, a
|
||||
--- `lambda` or a `Funcref`. See `option-value-function` for more
|
||||
--- `lambda` or a `Funcref`. See `option-value-function` for more
|
||||
--- information.
|
||||
---
|
||||
--- This option cannot be set from a `modeline` or in the `sandbox`, for
|
||||
@@ -6101,7 +6101,7 @@ vim.bo.sw = vim.bo.shiftwidth
|
||||
--- `:silent` was used for the command; note that this also
|
||||
--- affects messages from 'autoread' reloading
|
||||
--- S do not show search count message when searching, e.g. *shm-S*
|
||||
--- "[1/5]". When the "S" flag is not present (e.g. search count
|
||||
--- "[1/5]". When the "S" flag is not present (e.g. search count
|
||||
--- is shown), the "search hit BOTTOM, continuing at TOP" and
|
||||
--- "search hit TOP, continuing at BOTTOM" messages are only
|
||||
--- indicated by a "W" (Mnemonic: Wrapped) letter before the
|
||||
@@ -6556,7 +6556,7 @@ vim.bo.spo = vim.bo.spelloptions
|
||||
---
|
||||
--- timeout:{millisec} Limit the time searching for suggestions to
|
||||
--- {millisec} milliseconds. Applies to the following
|
||||
--- methods. When omitted the limit is 5000. When
|
||||
--- methods. When omitted the limit is 5000. When
|
||||
--- negative there is no limit.
|
||||
---
|
||||
--- file:{filename} Read file {filename}, which must have two columns,
|
||||
@@ -7254,7 +7254,7 @@ vim.go.tc = vim.go.tagcase
|
||||
--- The function gets the tag pattern and should return a List of matching
|
||||
--- tags. See `tag-function` for an explanation of how to write the
|
||||
--- function and an example. The value can be the name of a function, a
|
||||
--- `lambda` or a `Funcref`. See `option-value-function` for more
|
||||
--- `lambda` or a `Funcref`. See `option-value-function` for more
|
||||
--- information.
|
||||
--- This option cannot be set from a `modeline` or in the `sandbox`, for
|
||||
--- security reasons.
|
||||
@@ -8145,7 +8145,7 @@ vim.go.wim = vim.go.wildmode
|
||||
--- d #define
|
||||
--- f function
|
||||
---
|
||||
--- This option does not apply to `ins-completion`. See 'completeopt' for
|
||||
--- This option does not apply to `ins-completion`. See 'completeopt' for
|
||||
--- that.
|
||||
---
|
||||
--- @type string
|
||||
|
||||
Reference in New Issue
Block a user