xenia/kakoune
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document which option-types can be used with declare-options.

Browse Source
This commit is contained in:
Tim Allen 2018-08-21 18:24:33 +10:00
parent 49ef9968c0
commit ede9155fc7
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/pages/options.asciidoc
View File

@ -77,10 +77,13 @@ are exclusively available to built-in options.
*coord*:: *coord*::
a line, column pair (separated by a comma) a line, column pair (separated by a comma)
Cannot be used with `declare-option`
*<type>-list*:: *<type>-list*::
a list, elements are specified as separate arguments to the command. a list, elements are specified as separate arguments to the command.
`set -add` appends the new element to the list `set -add` appends the new element to the list
Only `int-list` and `str-list` options can be created with
`declare-option`.
*range-specs*:: *range-specs*::
a list of a pair of a buffer range (`<begin line>.<begin column>, a list of a pair of a buffer range (`<begin line>.<begin column>,
@ -110,11 +113,13 @@ are exclusively available to built-in options.
*enum(value1|value2|...)*:: *enum(value1|value2|...)*::
an enum, taking one of the given values an enum, taking one of the given values
Cannot be used with `declare-option`
*flags(value1|value2|...)*:: *flags(value1|value2|...)*::
a set of flags, taking a combination of the given values joined by a a set of flags, taking a combination of the given values joined by a
'|' character. '|' character.
`set -add` adds the new flag to the combination `set -add` adds the new flag to the combination
Cannot be used with `declare-option`
*<type>-to-<type>-map*:: *<type>-to-<type>-map*::
a list of `key=value` pairs. a list of `key=value` pairs.