Skip to content

Commit 917585f

Browse files
committed
[#2511][#2512] additional documentation edits
1 parent ac0a5b9 commit 917585f

3 files changed

Lines changed: 7 additions & 7 deletions

File tree

docs/index.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6259,9 +6259,9 @@ Usage: <main class> [-AbeEnstTuv] [--help] [--version] [FILE...]
62596259
Non-boolean options require a value. The usage help should explain this, and picocli shows the option parameter
62606260
in the synopsis and in the option list. By default, the field name is shown in `<` and `>` fish brackets.
62616261
Use the `paramLabel` attribute to display a different name. For manual control with no automatic formatting,
6262-
such as the two parameter case below, consider setting `hideParamSyntax=false`. For example:
6262+
such as the two parameter case below, consider setting `hideParamSyntax=true`. For example:
62636263
----
6264-
Usage: <main class> [-f=FILE] [-n=<number>] NUM <host>
6264+
Usage: <main class> [-d=NAME BODY] [-f=FILE] [-n=<number>] NUM <host>
62656265
NUM number param
62666266
host the host parameter
62676267
-f= FILE a file
@@ -12447,7 +12447,7 @@ class MyCDIApp implements Runnable {
1244712447
====
1244812448
Depending on your configuration, CDI may use dynamic proxies for managed instances.
1244912449

12450-
The safest thing to do in CDI applications is to use public <<option-parameters-methods,annotated **setter methods**>> for picocli's `@Option` and `@Parameters`, `@Spec`, and other annotations.
12450+
The safest thing to do in CDI applications is to use public <<option-parameters-methods,annotated **setter methods**>> for picocli's `@Option` and `@Parameters`, `@Spec`, and other annotations.
1245112451
Using picocli annotations on fields or on non-public methods may result in picocli-injected values not being available in the proxied instance.
1245212452
====
1245312453

docs/quick-guide.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -764,9 +764,9 @@ Usage: <main class> [-AbeEnstTuv] [--help] [--version] [FILE...]
764764
Non-boolean options require a value. The usage help should explain this, and picocli shows the option parameter
765765
in the synopsis and in the option list. By default, the field name is shown in `<` and `>` fish brackets.
766766
Use the `paramLabel` attribute to display a different name. For manual control with no automatic formatting,
767-
such as the two parameter case below, consider setting `hideParamSyntax=false`. For example:
767+
such as the two parameter case below, consider setting `hideParamSyntax=true`. For example:
768768
----
769-
Usage: <main class> [-f=FILE] [-n=<number>] NUM <host>
769+
Usage: <main class> [-d=NAME BODY] [-f=FILE] [-n=<number>] NUM <host>
770770
NUM number param
771771
host the host
772772
-f= FILE a file

src/main/java/picocli/CommandLine.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3923,8 +3923,8 @@ public enum ScopeType {
39233923
/** Returns whether usage syntax decorations around the {@linkplain #paramLabel() paramLabel} should be suppressed.
39243924
* The default is {@code false}: by default, the paramLabel is surrounded with {@code '['} and {@code ']'} characters
39253925
* if the value is optional and followed by ellipses ("...") when multiple values can be specified, and the parameter
3926-
* label is repeated for each parameter for multi-arity options. Should be disabled if full control over the formating
3927-
* is desired, such as different labels for each parameter.
3926+
* label is repeated for each parameter for multi-arity options.
3927+
* May be set to {@code true} if full control over the formating is desired, such as different labels for each parameter.
39283928
* @since 3.6.0 */
39293929
boolean hideParamSyntax() default false;
39303930

0 commit comments

Comments
 (0)