From ede9155fc778de8153806815c5bc413c7e1bf142 Mon Sep 17 00:00:00 2001 From: Tim Allen Date: Tue, 21 Aug 2018 18:24:33 +1000 Subject: [PATCH] Document which option-types can be used with declare-options. --- doc/pages/options.asciidoc | 5 +++++ 1 file changed, 5 insertions(+) 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` *-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 (`., @@ -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` *-to--map*:: a list of `key=value` pairs.