diff options
| author | Tim Allen <screwtape@froup.com> | 2018-08-21 18:24:33 +1000 |
|---|---|---|
| committer | Tim Allen <screwtape@froup.com> | 2018-08-21 18:24:33 +1000 |
| commit | ede9155fc778de8153806815c5bc413c7e1bf142 (patch) | |
| tree | 11c1e8b15be4f11c3b8797d625f82bc231ce4394 | |
| parent | 49ef9968c09f80c8bd213e522afd2cf8c7af2ff1 (diff) | |
Document which option-types can be used with declare-options.
| -rw-r--r-- | doc/pages/options.asciidoc | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/pages/options.asciidoc b/doc/pages/options.asciidoc index 860e4914..4c854afe 100644 --- a/doc/pages/options.asciidoc +++ b/doc/pages/options.asciidoc @@ -77,10 +77,13 @@ are exclusively available to built-in options. *coord*:: a line, column pair (separated by a comma) + Cannot be used with `declare-option` *<type>-list*:: a list, elements are specified as separate arguments to the command. `set -add` appends the new element to the list + Only `int-list` and `str-list` options can be created with + `declare-option`. *range-specs*:: 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|...)*:: an enum, taking one of the given values + Cannot be used with `declare-option` *flags(value1|value2|...)*:: a set of flags, taking a combination of the given values joined by a '|' character. `set -add` adds the new flag to the combination + Cannot be used with `declare-option` *<type>-to-<type>-map*:: a list of `key=value` pairs. |