From d04b2aa5c7ea4d843956b76b1fd9c4ec2ff21db6 Mon Sep 17 00:00:00 2001 From: Hamid Nazari Date: Sun, 2 Jan 2022 01:05:07 +0330 Subject: [PATCH 1/4] [DOC] Fixed sample code Sample code is revised to use `boolean` instead of `String` for `exclusive` annotation attribute --- docs/index.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/index.adoc b/docs/index.adoc index 72ac75954..b287e9026 100644 --- a/docs/index.adoc +++ b/docs/index.adoc @@ -3230,7 +3230,7 @@ class MyApp implements Runnable { static class Outer { @Option(names = "-x", defaultValue = "XX") String x = "XX"; - @ArgGroup(exclusive = "true") + @ArgGroup(exclusive = true) Inner inner; // no initial value } @@ -3265,7 +3265,7 @@ class MyApp : Runnable { class Outer { @Option(names = "-x", defaultValue = "XX") var x = "XX"; - @ArgGroup(exclusive = "true") + @ArgGroup(exclusive = true) lateinit var inner: Inner // no initial value } From 739aa56894817462f5ad48e4994da0f0b71df9f9 Mon Sep 17 00:00:00 2001 From: Hamid Nazari Date: Sun, 2 Jan 2022 01:12:22 +0330 Subject: [PATCH 2/4] [DOC] Revised typo in documentation Changed "ore" to "or" in various places --- docs/A-Whirlwind-Tour-of-Picocli.adoc | 2 +- docs/A-Whirlwind-Tour-of-Picocli.html | 2 +- docs/index.adoc | 8 ++++---- docs/index.html | 8 ++++---- docs/man/1.x/index.html | 4 ++-- docs/man/2.x/index.html | 4 ++-- docs/man/3.x/index.html | 4 ++-- docs/man/3.x/quick-guide.html | 4 ++-- docs/quick-guide.adoc | 8 ++++---- docs/quick-guide.html | 8 ++++---- 10 files changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/A-Whirlwind-Tour-of-Picocli.adoc b/docs/A-Whirlwind-Tour-of-Picocli.adoc index f0c8c5c9a..8b3324145 100644 --- a/docs/A-Whirlwind-Tour-of-Picocli.adoc +++ b/docs/A-Whirlwind-Tour-of-Picocli.adoc @@ -476,7 +476,7 @@ Usage:
[OPTIONS] [...] Note that the positional parameters are not abbreviated. === Custom Synopsis -For even more control of the synopsis, use the `customSynopsis` attribute to specify one ore more synopsis lines. For example: +For even more control of the synopsis, use the `customSynopsis` attribute to specify one or more synopsis lines. For example: .Example custom synopsis with multiple lines ---- diff --git a/docs/A-Whirlwind-Tour-of-Picocli.html b/docs/A-Whirlwind-Tour-of-Picocli.html index 6c2bca36a..125d9ba6a 100644 --- a/docs/A-Whirlwind-Tour-of-Picocli.html +++ b/docs/A-Whirlwind-Tour-of-Picocli.html @@ -2293,7 +2293,7 @@

Abbreviated Synopsis

Custom Synopsis

-

For even more control of the synopsis, use the customSynopsis attribute to specify one ore more synopsis lines. For example:

+

For even more control of the synopsis, use the customSynopsis attribute to specify one or more synopsis lines. For example:

Example custom synopsis with multiple lines
diff --git a/docs/index.adoc b/docs/index.adoc index b287e9026..401f8310a 100644 --- a/docs/index.adoc +++ b/docs/index.adoc @@ -432,7 +432,7 @@ class Tar { @Option(names = { "-f", "--file" }, paramLabel = "ARCHIVE", description = "the archive file") File archive; - @Parameters(paramLabel = "FILE", description = "one ore more files to archive") + @Parameters(paramLabel = "FILE", description = "one or more files to archive") File[] files; @Option(names = { "-h", "--help" }, usageHelp = true, description = "display a help message") @@ -450,7 +450,7 @@ class Tar : Runnable { @Option(names = ["-f", "--file"], paramLabel = "ARCHIVE", description = ["the archive file"]) lateinit var archive: File; - @Parameters(paramLabel = "FILE", description = ["one ore more files to archive"]) + @Parameters(paramLabel = "FILE", description = ["one or more files to archive"]) lateinit var files: Array; @Option(names = ["-h", "--help"], usageHelp = true, description = ["display a help message"]) @@ -6081,7 +6081,7 @@ class App { ---- === Custom Synopsis -For even more control of the synopsis, use the `customSynopsis` attribute to specify one ore more synopsis lines. For example: +For even more control of the synopsis, use the `customSynopsis` attribute to specify one or more synopsis lines. For example: ---- Usage: ln [OPTION]... [-T] TARGET LINK_NAME (1st form) or: ln [OPTION]... TARGET (2nd form) @@ -11861,7 +11861,7 @@ In a production system, to have to set the boolean configuration value `quarkus. Please refer to the Quarkus guide https://quarkus.io/guides/mailer[Sending Emails] for details and additional information. ==== -As an extra, our command line interface offers the opportunity to specify one ore more custom header lines via the `headers` subcommand, more specifically via the `--header` option (`KEY="MY VALUE STRINGS"`) of this subcommand: +As an extra, our command line interface offers the opportunity to specify one or more custom header lines via the `headers` subcommand, more specifically via the `--header` option (`KEY="MY VALUE STRINGS"`) of this subcommand: ---- ./mvnw compile quarkus:dev -Dquarkus.args="--from= ... --to ... body message headers \ --header X-Mailer=Picocli/Quarkus --header X-Mailer-Version=1.0" diff --git a/docs/index.html b/docs/index.html index c9e5c859a..54544d295 100644 --- a/docs/index.html +++ b/docs/index.html @@ -2692,7 +2692,7 @@

3.1. Options

@Option(names = { "-f", "--file" }, paramLabel = "ARCHIVE", description = "the archive file") File archive; - @Parameters(paramLabel = "FILE", description = "one ore more files to archive") + @Parameters(paramLabel = "FILE", description = "one or more files to archive") File[] files; @Option(names = { "-h", "--help" }, usageHelp = true, description = "display a help message") @@ -2710,7 +2710,7 @@

3.1. Options

@Option(names = ["-f", "--file"], paramLabel = "ARCHIVE", description = ["the archive file"]) lateinit var archive: File; - @Parameters(paramLabel = "FILE", description = ["one ore more files to archive"]) + @Parameters(paramLabel = "FILE", description = ["one or more files to archive"]) lateinit var files: Array<File>; @Option(names = ["-h", "--help"], usageHelp = true, description = ["display a help message"]) @@ -9936,7 +9936,7 @@

<

14.9. Custom Synopsis

-

For even more control of the synopsis, use the customSynopsis attribute to specify one ore more synopsis lines. For example:

+

For even more control of the synopsis, use the customSynopsis attribute to specify one or more synopsis lines. For example:

@@ -16854,7 +16854,7 @@

22.4. Q

-

As an extra, our command line interface offers the opportunity to specify one ore more custom header lines via the headers subcommand, more specifically via the --header option (KEY="MY VALUE STRINGS") of this subcommand:

+

As an extra, our command line interface offers the opportunity to specify one or more custom header lines via the headers subcommand, more specifically via the --header option (KEY="MY VALUE STRINGS") of this subcommand:

diff --git a/docs/man/1.x/index.html b/docs/man/1.x/index.html index 1a8a5307c..6b4759b68 100644 --- a/docs/man/1.x/index.html +++ b/docs/man/1.x/index.html @@ -787,7 +787,7 @@

2.1. Options

@Option(names = { "-f", "--file" }, paramLabel = "ARCHIVE", description = "the archive file") File archive; - @Parameters(paramLabel = "FILE", description = "one ore more files to archive") + @Parameters(paramLabel = "FILE", description = "one or more files to archive") File[] files; @Option(names = { "-h", "--help" }, usageHelp = true, description = "display a help message") @@ -1674,7 +1674,7 @@

8.5. Abbreviated Synopsis

8.6. Custom Synopsis

-

For even more control of the synopsis, use the customSynopsis attribute to specify one ore more synopsis lines. For example:

+

For even more control of the synopsis, use the customSynopsis attribute to specify one or more synopsis lines. For example:

diff --git a/docs/man/2.x/index.html b/docs/man/2.x/index.html index 70897267b..9a35e9be5 100644 --- a/docs/man/2.x/index.html +++ b/docs/man/2.x/index.html @@ -804,7 +804,7 @@

2.1. Options

@Option(names = { "-f", "--file" }, paramLabel = "ARCHIVE", description = "the archive file") File archive; - @Parameters(paramLabel = "FILE", description = "one ore more files to archive") + @Parameters(paramLabel = "FILE", description = "one or more files to archive") File[] files; @Option(names = { "-h", "--help" }, usageHelp = true, description = "display a help message") @@ -2314,7 +2314,7 @@

9.5. Abbreviated Synopsis

9.6. Custom Synopsis

-

For even more control of the synopsis, use the customSynopsis attribute to specify one ore more synopsis lines. For example:

+

For even more control of the synopsis, use the customSynopsis attribute to specify one or more synopsis lines. For example:

diff --git a/docs/man/3.x/index.html b/docs/man/3.x/index.html index 31870d66e..ba1b218a6 100644 --- a/docs/man/3.x/index.html +++ b/docs/man/3.x/index.html @@ -860,7 +860,7 @@

2.1. Options

@Option(names = { "-f", "--file" }, paramLabel = "ARCHIVE", description = "the archive file") File archive; - @Parameters(paramLabel = "FILE", description = "one ore more files to archive") + @Parameters(paramLabel = "FILE", description = "one or more files to archive") File[] files; @Option(names = { "-h", "--help" }, usageHelp = true, description = "display a help message") @@ -2900,7 +2900,7 @@

10.6. Abbreviated Synopsis

10.7. Custom Synopsis

-

For even more control of the synopsis, use the customSynopsis attribute to specify one ore more synopsis lines. For example:

+

For even more control of the synopsis, use the customSynopsis attribute to specify one or more synopsis lines. For example:

diff --git a/docs/man/3.x/quick-guide.html b/docs/man/3.x/quick-guide.html index 138513385..8811a4769 100644 --- a/docs/man/3.x/quick-guide.html +++ b/docs/man/3.x/quick-guide.html @@ -652,7 +652,7 @@

3.1. Options

@Option(names = { "-f", "--file" }, paramLabel = "ARCHIVE", description = "the archive file") File archive; - @Parameters(paramLabel = "FILE", description = "one ore more files to archive") + @Parameters(paramLabel = "FILE", description = "one or more files to archive") File[] files; @Option(names = { "-h", "--help" }, usageHelp = true, description = "display a help message") @@ -1210,7 +1210,7 @@

9.2.4. Abbreviated Synopsis

9.2.5. Custom Synopsis

-

For even more control of the synopsis, use the customSynopsis attribute to specify one ore more synopsis lines. For example:

+

For even more control of the synopsis, use the customSynopsis attribute to specify one or more synopsis lines. For example:

diff --git a/docs/quick-guide.adoc b/docs/quick-guide.adoc index ad4a7e271..1310ba317 100644 --- a/docs/quick-guide.adoc +++ b/docs/quick-guide.adoc @@ -232,7 +232,7 @@ public class ISOCodeResolver { // <1> } @Command(name = "language", - description = "Resolves one ore more ISO language codes (ISO-639-1 or 639-2)") // <4> + description = "Resolves one or more ISO language codes (ISO-639-1 or 639-2)") // <4> class SubcommandAsClass implements Runnable { @Parameters(arity = "1..*", paramLabel = "", description = "language code(s)") @@ -367,7 +367,7 @@ Resolves ISO country codes (ISO-3166-1) or language codes (ISO-639-1/-2) Commands: help Displays help information about the specified command country Resolves ISO country codes (ISO-3166-1) - language Resolves one ore more ISO language codes (ISO-639-1 or 639-2) + language Resolves one or more ISO language codes (ISO-639-1 or 639-2) ---- === ISOCodeResolver execution: try it! @@ -408,7 +408,7 @@ class Tar { @Option(names = { "-f", "--file" }, paramLabel = "ARCHIVE", description = "the archive file") File archive; - @Parameters(paramLabel = "FILE", description = "one ore more files to archive") + @Parameters(paramLabel = "FILE", description = "one or more files to archive") File[] files; @Option(names = { "-h", "--help" }, usageHelp = true, description = "display a help message") @@ -807,7 +807,7 @@ Usage:
[OPTIONS] [...] ==== Custom Synopsis -For even more control of the synopsis, use the `customSynopsis` attribute to specify one ore more synopsis lines. For example: +For even more control of the synopsis, use the `customSynopsis` attribute to specify one or more synopsis lines. For example: ---- Usage: ln [OPTION]... [-T] TARGET LINK_NAME (1st form) or: ln [OPTION]... TARGET (2nd form) diff --git a/docs/quick-guide.html b/docs/quick-guide.html index 255508741..1cb8b8f38 100644 --- a/docs/quick-guide.html +++ b/docs/quick-guide.html @@ -2135,7 +2135,7 @@

} @Command(name = "language", - description = "Resolves one ore more ISO language codes (ISO-639-1 or 639-2)") (4) + description = "Resolves one or more ISO language codes (ISO-639-1 or 639-2)") (4) class SubcommandAsClass implements Runnable { @Parameters(arity = "1..*", paramLabel = "<languageCode>", description = "language code(s)") @@ -2305,7 +2305,7 @@

4.1. Options

@Option(names = { "-f", "--file" }, paramLabel = "ARCHIVE", description = "the archive file") File archive; - @Parameters(paramLabel = "FILE", description = "one ore more files to archive") + @Parameters(paramLabel = "FILE", description = "one or more files to archive") File[] files; @Option(names = { "-h", "--help" }, usageHelp = true, description = "display a help message") @@ -2923,7 +2923,7 @@

<

10.2.5. Custom Synopsis

-

For even more control of the synopsis, use the customSynopsis attribute to specify one ore more synopsis lines. For example:

+

For even more control of the synopsis, use the customSynopsis attribute to specify one or more synopsis lines. For example:

From 3a771592e72606b90554da3d31053058315ad0ac Mon Sep 17 00:00:00 2001 From: Hamid Nazari Date: Mon, 3 Jan 2022 00:53:45 +0330 Subject: [PATCH 3/4] [DOC] Revised subcommand alias section In the context of subcommand aliases, modified statements were referring to "commands" which are changed to "subcommands" --- docs/index.adoc | 2 +- docs/index.html | 2 +- docs/man/3.x/index.html | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/index.adoc b/docs/index.adoc index 401f8310a..4b2fecf1e 100644 --- a/docs/index.adoc +++ b/docs/index.adoc @@ -8060,7 +8060,7 @@ class ListFiles : Runnable { ---- === Subcommand Aliases -Commands may optionally define an `aliases` attribute to provide alternate names for commands that will be recognized by the parser. Aliases are displayed in the default help output. For example: +Commands may optionally define an `aliases` attribute to provide alternate names for subcommands that will be recognized by the parser. Aliases are displayed in the default help output. For example: .Java [source,java,role="primary"] diff --git a/docs/index.html b/docs/index.html index 54544d295..289a27f93 100644 --- a/docs/index.html +++ b/docs/index.html @@ -12344,7 +12344,7 @@

17.8. Subcommand Aliases

-

Commands may optionally define an aliases attribute to provide alternate names for commands that will be recognized by the parser. Aliases are displayed in the default help output. For example:

+

Commands may optionally define an aliases attribute to provide alternate names for subcommands that will be recognized by the parser. Aliases are displayed in the default help output. For example:

Java
diff --git a/docs/man/3.x/index.html b/docs/man/3.x/index.html index ba1b218a6..805f7b585 100644 --- a/docs/man/3.x/index.html +++ b/docs/man/3.x/index.html @@ -3815,7 +3815,7 @@

13.2. Registering Subcommands De

13.3. Subcommand Aliases

-

Commands may optionally define an aliases attribute to provide alternate names for commands that will be recognized by the parser. Aliases are displayed in the default help output. For example:

+

Commands may optionally define an aliases attribute to provide alternate names for subcommands that will be recognized by the parser. Aliases are displayed in the default help output. For example:

From 9366fa1ad17a65061337d68f1851df9e65068e34 Mon Sep 17 00:00:00 2001 From: Hamid Nazari Date: Mon, 3 Jan 2022 17:15:02 +0330 Subject: [PATCH 4/4] [DOC-PR#1539] Revised documentation I've made changes to alleviate ambiguity around "commands" and "subcommands" in the context of aliases --- docs/index.adoc | 2 +- docs/index.html | 2 +- docs/man/3.x/index.html | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/index.adoc b/docs/index.adoc index 4b2fecf1e..830e163ed 100644 --- a/docs/index.adoc +++ b/docs/index.adoc @@ -8060,7 +8060,7 @@ class ListFiles : Runnable { ---- === Subcommand Aliases -Commands may optionally define an `aliases` attribute to provide alternate names for subcommands that will be recognized by the parser. Aliases are displayed in the default help output. For example: +Commands may optionally define an `aliases` attribute to provide alternate names that will be recognized by the parser. Aliases are displayed in the default help output. For example: .Java [source,java,role="primary"] diff --git a/docs/index.html b/docs/index.html index 289a27f93..158343da9 100644 --- a/docs/index.html +++ b/docs/index.html @@ -12344,7 +12344,7 @@

17.8. Subcommand Aliases

-

Commands may optionally define an aliases attribute to provide alternate names for subcommands that will be recognized by the parser. Aliases are displayed in the default help output. For example:

+

Commands may optionally define an aliases attribute to provide alternate names that will be recognized by the parser. Aliases are displayed in the default help output. For example:

Java
diff --git a/docs/man/3.x/index.html b/docs/man/3.x/index.html index 805f7b585..065487ce2 100644 --- a/docs/man/3.x/index.html +++ b/docs/man/3.x/index.html @@ -3815,7 +3815,7 @@

13.2. Registering Subcommands De

13.3. Subcommand Aliases

-

Commands may optionally define an aliases attribute to provide alternate names for subcommands that will be recognized by the parser. Aliases are displayed in the default help output. For example:

+

Commands may optionally define an aliases attribute to provide alternate names that will be recognized by the parser. Aliases are displayed in the default help output. For example: