[remkop#1398][remkop#1400] additional clarification

MarkoMackic · Oct 17, 2021 · 9ef376a · 9ef376a
1 parent c0039ae
commit 9ef376a
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/main/java/picocli/CommandLine.java b/src/main/java/picocli/CommandLine.java
@@ -3746,7 +3746,8 @@ public enum ScopeType {
          * </p>
          * <b>A note on boolean options</b>
          * <p>
-         * By default picocli allows boolean options (also called "flags" or "switches") to have an optional parameter.
+         * By default picocli allows boolean options (also called "flags" or "switches") to have an optional parameter,
+         * which must be either "true" or "false" (lowercase, other values are rejected).
          * You can make a boolean option take a required parameter by annotating your field with {@code arity="1"}.
          * For example: </p>
          * <pre>&#064;Option(names = "-v", arity = "1") boolean verbose;</pre>