Documentation: Update boolean arity #1400
Conversation
|
There might be some doc missing. @remkop I am assuming the html is somehow autogenerated? Or do I need to update it as well? |
|
Some background on how this is implemented: If a positional parameter is defined without explicitly setting the arity, picocli automatically assigns arity="1". During parsing, picocli creates a "derived arity" for each option it recognizes: named options with a value attached to the option name will have derived arity="1". For example, Picocli uses this "derived arity" if the option was defined without an explicit arity (so when "unspecified=true"). Effectively, this means that from a validation point of view, booleans have arity="0..1". Anyway, that is why the docs say that arity=0 for booleans, when arity=0..1 is more accurate. (It does not tell the whole story, but I guess that is okay.) |
| @@ -3746,22 +3746,12 @@ private static String format(String formatString, Object... params) { | |||
| * </p> | |||
| * <b>A note on boolean options</b> | |||
| * <p> | |||
| * By default picocli does not expect boolean options (also called "flags" or "switches") to have a parameter. | |||
| * You can make a boolean option take a required parameter by annotating your field with {@code arity="1"}. | |||
| * By default picocli allows boolean options (also called "flags" or "switches") to have an optional parameter. | |||
There was a problem hiding this comment.
Small addition:
(...) an optional parameter, which must be either
trueorfalse.
There was a problem hiding this comment.
I think this one is very redundant, it's a boolean option.
There was a problem hiding this comment.
I see what you are saying, but I think it makes sense to be very specific about what parameters are allowed. For example, the following parameters would be rejected: TRUE, FALSE, True, False, 1, 0, YES, NO, Yes, No.
Contrast this to some languages like Groovy and Python where Strings with this wider range of values are translated to true/false boolean values.
The default arity for boolean options is 0..1 and no longer 0.
|
Merged. |
The default arity for boolean options is 0..1 and no longer 0.
This reverts commit 4ac3aba.
This reverts commit 9ef376a.
This reverts commit c0039ae.
This reverts commit 4ac3aba.
This reverts commit 9ef376a.
This reverts commit c0039ae.
The default arity for boolean options is 0..1 and no longer 0.
Closes #1398.