adam/vim
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

runtime(doc): Tweak documentation style more in options and ft_hare

Browse Source 
closes: 18289

Signed-off-by: Hirohito Higashi <h.east.727@gmail.com>
Signed-off-by: Christian Brabandt <cb@256bit.org>
This commit is contained in:
Hirohito Higashi
2025-09-14 11:05:46 -04:00
committed by Christian Brabandt
parent 46e22fd2f7
commit 235e77a3a3
2 changed files with 35 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
runtime/doc/ft_hare.txt
View File

@ -46,7 +46,7 @@ To disable this behavior, add the following to your |vimrc|: >
< <
*g:hare_symbol_operators* *g:hare_symbol_operators*
By default, symbolic operators do not receive any special highlighting (with By default, symbolic operators do not receive any special highlighting (with
`!`, `?`, and `::` being the only exceptions). To enable syntax highlighting `!`, `?`, and `::` being the only exceptions). To enable syntax highlighting
for most other operators, add the following to your |vimrc|: > for most other operators, add the following to your |vimrc|: >
let g:hare_symbol_operators = 1 let g:hare_symbol_operators = 1
@ -111,7 +111,7 @@ case: >hare
// ... // ...
If you prefer a different amount of indentation, you can adjust it using If you prefer a different amount of indentation, you can adjust it using
|g:hare_indent_case|. Valid values include `0`, `1`, and `2`. |g:hare_indent_case|. Valid values include `0`, `1`, and `2`.
COMPILER SUPPORT *compiler-hare* COMPILER SUPPORT *compiler-hare*

66
runtime/doc/options.txt
View File

@ -80,7 +80,7 @@ achieve special effects. These options come in three forms:
'0o'). '0o').
The old value can be inserted by typing 'wildchar' (by The old value can be inserted by typing 'wildchar' (by
default this is a <Tab> or CTRL-E if 'compatible' is default this is a <Tab> or CTRL-E if 'compatible' is
set). Many string options with fixed syntax and names set). Many string options with fixed syntax and names
also support completing known values. See also support completing known values. See
|cmdline-completion| and |complete-set-option|. |cmdline-completion| and |complete-set-option|.
White space between {option} and '=' is allowed and White space between {option} and '=' is allowed and
@ -973,7 +973,7 @@ A jump table for the options with a short description can be found at |Q_op|.
'autoshelldir' 'asd' boolean (default off) 'autoshelldir' 'asd' boolean (default off)
global global
When on, Vim will change the current working directory whenever you When on, Vim will change the current working directory whenever you
change the directory of the shell running in a terminal window. You change the directory of the shell running in a terminal window. You
need proper setting-up, so whenever the shell's pwd changes an OSC 7 need proper setting-up, so whenever the shell's pwd changes an OSC 7
escape sequence will be emitted. For example, on Linux, you can escape sequence will be emitted. For example, on Linux, you can
source /etc/profile.d/vte.sh in your shell profile if you use bash or source /etc/profile.d/vte.sh in your shell profile if you use bash or
@ -1232,7 +1232,7 @@ A jump table for the options with a short description can be found at |Q_op|.
- A directory name may end in an '/'. - A directory name may end in an '/'.
- For Unix and Win32, if a directory ends in two path separators "//", - For Unix and Win32, if a directory ends in two path separators "//",
the backup file name will be built from the complete path to the the backup file name will be built from the complete path to the
file with all path separators changed to percent '%' signs. This file with all path separators changed to percent '%' signs. This
will ensure file name uniqueness in the backup directory. will ensure file name uniqueness in the backup directory.
On Win32, it is also possible to end with "\\". However, When a On Win32, it is also possible to end with "\\". However, When a
separating comma is following, you must use "//", since "\\" will separating comma is following, you must use "//", since "\\" will
@ -1361,7 +1361,7 @@ A jump table for the options with a short description can be found at |Q_op|.
or Sun Workshop). or Sun Workshop).
If the expression starts with s: or |<SID>|, then it is replaced with 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: >
set bexpr=s:MyBalloonExpr() set bexpr=s:MyBalloonExpr()
set bexpr=<SID>SomeBalloonExpr() set bexpr=<SID>SomeBalloonExpr()
< Otherwise, the expression is evaluated in the context of the script < Otherwise, the expression is evaluated in the context of the script
@ -1384,10 +1384,10 @@ A jump table for the options with a short description can be found at |Q_op|.
*'belloff'* *'bo'* *'belloff'* *'bo'*
'belloff' 'bo' string (default "") 'belloff' 'bo' string (default "")
global global
Specifies for which events the bell will not be rung. It is a comma 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 separated list of items. For each item that is present, the bell will
will be silenced. This is most useful to specify specific events in be silenced. This is most useful to specify specific events in insert
insert mode to be silenced. mode to be silenced.
You can also make it flash by using 'visualbell'. You can also make it flash by using 'visualbell'.
item meaning when present ~ item meaning when present ~
@ -1419,8 +1419,8 @@ A jump table for the options with a short description can be found at |Q_op|.
(depends on the 'wildmode' setting). (depends on the 'wildmode' setting).
This is most useful to fine tune when in Insert mode the bell should 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 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 indicate that an error occurred. It can be silenced by adding the
"error" keyword. "error" keyword.
*'binary'* *'bin'* *'nobinary'* *'nobin'* *'binary'* *'bin'* *'nobinary'* *'nobin'*
@ -1502,11 +1502,11 @@ A jump table for the options with a short description can be found at |Q_op|.
local to window local to window
{not available when compiled without the |+linebreak| {not available when compiled without the |+linebreak|
feature} feature}
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: items and must be separated by a comma:
min:{n} Minimum text width that will be kept after min:{n} Minimum text width that will be kept after
applying 'breakindent', even if the resulting 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 text indented almost to the right window border
occupying lots of vertical space when broken. occupying lots of vertical space when broken.
(default: 20) (default: 20)
@ -1525,8 +1525,8 @@ A jump table for the options with a short description can be found at |Q_op|.
(default: 0) (default: 0)
list:-1 Uses the width of a match with 'formatlistpat' for list:-1 Uses the width of a match with 'formatlistpat' for
indentation. indentation.
column:{n} Indent at column {n}. Will overrule the other column:{n} Indent at column {n}. Will overrule the other
sub-options. Note: an additional indent may be sub-options. Note: an additional indent may be
added for the 'showbreak' setting. added for the 'showbreak' setting.
(default: off) (default: off)
@ -1736,7 +1736,7 @@ A jump table for the options with a short description can be found at |Q_op|.
of this. of this.
If the 'charconvert' expression starts with s: or |<SID>|, then it is 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: >
set charconvert=s:MyConvert() set charconvert=s:MyConvert()
set charconvert=<SID>SomeConvert() set charconvert=<SID>SomeConvert()
< Otherwise the expression is evaluated in the context of the script < Otherwise the expression is evaluated in the context of the script
@ -2203,7 +2203,7 @@ A jump table for the options with a short description can be found at |Q_op|.
with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U| with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
See |complete-functions| for an explanation of how the function is 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 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. more information.
This option cannot be set from a |modeline| or in the |sandbox|, for This option cannot be set from a |modeline| or in the |sandbox|, for
security reasons. security reasons.
@ -2319,7 +2319,7 @@ A jump table for the options with a short description can be found at |Q_op|.
Only "fuzzy", "popup", "popuphidden", "preinsert" and "preview" have Only "fuzzy", "popup", "popuphidden", "preinsert" and "preview" have
an effect when 'autocomplete' is enabled. 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. for that.
*'completepopup'* *'cpp'* *'completepopup'* *'cpp'*
@ -3235,7 +3235,7 @@ A jump table for the options with a short description can be found at |Q_op|.
- For Unix and Win32, if a directory ends in two path separators "//", - 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 the swap file name will be built from the complete path to the file
with all path separators replaced by percent '%' signs (including 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. file name uniqueness in the preserve directory.
On Win32, it is also possible to end with "\\". However, When a On Win32, it is also possible to end with "\\". However, When a
separating comma is following, you must use "//", since "\\" will separating comma is following, you must use "//", since "\\" will
@ -4156,7 +4156,7 @@ A jump table for the options with a short description can be found at |Q_op|.
the internal format mechanism. the internal format mechanism.
If the expression starts with s: or |<SID>|, then it is replaced with 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: >
set formatexpr=s:MyFormatExpr() set formatexpr=s:MyFormatExpr()
set formatexpr=<SID>SomeFormatExpr() set formatexpr=<SID>SomeFormatExpr()
< Otherwise, the expression is evaluated in the context of the script < Otherwise, the expression is evaluated in the context of the script
@ -4854,8 +4854,8 @@ A jump table for the options with a short description can be found at |Q_op|.
global global
This option specifies a function that will be called to This option specifies a function that will be called to
activate or deactivate the Input Method. The value can be the name of activate or deactivate the Input Method. The value can be the name of
a function, a |lambda| or a |Funcref|. See |option-value-function| for a function, a |lambda| or a |Funcref|. See |option-value-function|
more information. for more information.
It is not used in the MS-Windows GUI version. It is not used in the MS-Windows GUI version.
The expression will be evaluated in the |sandbox| when set from a The expression will be evaluated in the |sandbox| when set from a
modeline, see |sandbox-option|. modeline, see |sandbox-option|.
@ -5034,7 +5034,7 @@ A jump table for the options with a short description can be found at |Q_op|.
Note: Not used for |<cfile>|. Note: Not used for |<cfile>|.
If the expression starts with s: or |<SID>|, then it is replaced with 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: >
setlocal includeexpr=s:MyIncludeExpr() setlocal includeexpr=s:MyIncludeExpr()
setlocal includeexpr=<SID>SomeIncludeExpr() setlocal includeexpr=<SID>SomeIncludeExpr()
< Otherwise, the expression is evaluated in the context of the script < Otherwise, the expression is evaluated in the context of the script
@ -5118,7 +5118,7 @@ A jump table for the options with a short description can be found at |Q_op|.
when the expression is evaluated (but it may be moved around). when the expression is evaluated (but it may be moved around).
If the expression starts with s: or |<SID>|, then it is replaced with 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: >
set indentexpr=s:MyIndentExpr() set indentexpr=s:MyIndentExpr()
set indentexpr=<SID>SomeIndentExpr() set indentexpr=<SID>SomeIndentExpr()
< Otherwise, the expression is evaluated in the context of the script < Otherwise, the expression is evaluated in the context of the script
@ -6430,7 +6430,7 @@ A jump table for the options with a short description can be found at |Q_op|.
completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O| completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
See |complete-functions| for an explanation of how the function is 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 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. more information.
This option is usually set by a filetype plugin: This option is usually set by a filetype plugin:
|:filetype-plugin-on| |:filetype-plugin-on|
@ -6452,7 +6452,7 @@ A jump table for the options with a short description can be found at |Q_op|.
global global
This option specifies a function to be called by the |g@| operator. 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 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. |option-value-function| for more information.
This option cannot be set from a |modeline| or in the |sandbox|, for This option cannot be set from a |modeline| or in the |sandbox|, for
@ -6851,8 +6851,8 @@ A jump table for the options with a short description can be found at |Q_op|.
Available values are 0, 2 and 3. Available values are 0, 2 and 3.
If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3` any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise
to 2 if Python 2 is available. sets to 2 if Python 2 is available.
See also: |has-pythonx| See also: |has-pythonx|
If Vim is compiled with only |+python| or |+python3| setting If Vim is compiled with only |+python| or |+python3| setting
@ -6873,7 +6873,7 @@ A jump table for the options with a short description can be found at |Q_op|.
for each entry in the corresponding quickfix or location list. See for each entry in the corresponding quickfix or location list. See
|quickfix-window-function| for an explanation of how to write the |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 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. information.
This option cannot be set from a |modeline| or in the |sandbox|, for This option cannot be set from a |modeline| or in the |sandbox|, for
@ -7760,7 +7760,7 @@ A jump table for the options with a short description can be found at |Q_op|.
`:silent` was used for the command; note that this also `:silent` was used for the command; note that this also
affects messages from autocommands and 'autoread' reloading affects messages from autocommands and 'autoread' reloading
S do not show search count message when searching, e.g. *shm-S* 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 is shown), the "search hit BOTTOM, continuing at TOP" and
"search hit TOP, continuing at BOTTOM" messages are only "search hit TOP, continuing at BOTTOM" messages are only
indicated by a "W" (Mnemonic: Wrapped) letter before the indicated by a "W" (Mnemonic: Wrapped) letter before the
@ -8186,7 +8186,7 @@ A jump table for the options with a short description can be found at |Q_op|.
timeout:{millisec} Limit the time searching for suggestions to timeout:{millisec} Limit the time searching for suggestions to
{millisec} milliseconds. Applies to the following {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. {only works when built negative there is no limit. {only works when built
with the |+reltime| feature} with the |+reltime| feature}
@ -8780,7 +8780,7 @@ A jump table for the options with a short description can be found at |Q_op|.
The function gets the tag pattern and should return a List of matching 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 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 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. information.
This option cannot be set from a |modeline| or in the |sandbox|, for This option cannot be set from a |modeline| or in the |sandbox|, for
security reasons. security reasons.
@ -9606,7 +9606,7 @@ A jump table for the options with a short description can be found at |Q_op|.
{not available when compiled without the |+viminfo| {not available when compiled without the |+viminfo|
feature} feature}
When non-empty, the viminfo file is read upon startup and written When non-empty, the viminfo file is read upon startup and written
when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
"NONE". "NONE".
The string should be a comma-separated list of parameters, each The string should be a comma-separated list of parameters, each
consisting of a single character identifying the particular parameter, consisting of a single character identifying the particular parameter,
@ -10050,7 +10050,7 @@ A jump table for the options with a short description can be found at |Q_op|.
d #define d #define
f function 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. that.
*'winaltkeys'* *'wak'* *'winaltkeys'* *'wak'*