Merge pull request #4220 from epage/quote

fix(parser): Quote the suggested help
clap-rs · Sep 15, 2022 · 71cdd24 · 71cdd24
2 parents 0479d8e + 0184cf0
commit 71cdd24
Show file tree

Hide file tree

Showing 32 changed files with 87 additions and 87 deletions.
diff --git a/examples/derive_ref/custom-bool.md b/examples/derive_ref/custom-bool.md
@@ -25,7 +25,7 @@ error: The following required arguments were not provided:
 
 Usage: custom-bool[EXE] --foo <FOO> <BOOM>
 
-For more information try --help
+For more information try '--help'
 
 $ custom-bool --foo true false
 [examples/derive_ref/custom-bool.rs:31] opt = Opt {

diff --git a/examples/derive_ref/interop_tests.md b/examples/derive_ref/interop_tests.md
@@ -41,7 +41,7 @@ error: Found argument '--unknown' which wasn't expected, or isn't valid in this
 
 Usage: interop_augment_args[EXE] [OPTIONS]
 
-For more information try --help
+For more information try '--help'
 
 ```
 
@@ -78,7 +78,7 @@ error: Found argument '--unknown' which wasn't expected, or isn't valid in this
 
 Usage: interop_augment_subcommands[EXE] derived [OPTIONS]
 
-For more information try --help
+For more information try '--help'
 
 ```
 
@@ -89,7 +89,7 @@ error: The subcommand 'unknown' wasn't recognized
 
 Usage: interop_augment_subcommands[EXE] [COMMAND]
 
-For more information try --help
+For more information try '--help'
 
 ```
 
@@ -150,7 +150,7 @@ error: Found argument '--unknown' which wasn't expected, or isn't valid in this
 
 Usage: interop_hand_subcommand[EXE] add [NAME]...
 
-For more information try --help
+For more information try '--help'
 
 ```
 
@@ -193,7 +193,7 @@ error: The subcommand 'unknown' wasn't recognized
 
 Usage: interop_hand_subcommand[EXE] [OPTIONS] <COMMAND>
 
-For more information try --help
+For more information try '--help'
 
 ```
 
@@ -249,6 +249,6 @@ error: Found argument '--unknown' which wasn't expected, or isn't valid in this
 
 Usage: interop_flatten_hand_args[EXE] [OPTIONS]
 
-For more information try --help
+For more information try '--help'
 
 ```
diff --git a/examples/escaped-positional-derive.md b/examples/escaped-positional-derive.md
@@ -37,7 +37,7 @@ error: Found argument 'foo' which wasn't expected, or isn't valid in this contex
 
 Usage: escaped-positional-derive[EXE] [OPTIONS] [-- <SLOP>...]
 
-For more information try --help
+For more information try '--help'
 
 ```
 

diff --git a/examples/escaped-positional.md b/examples/escaped-positional.md
@@ -37,7 +37,7 @@ error: Found argument 'foo' which wasn't expected, or isn't valid in this contex
 
 Usage: escaped-positional[EXE] [OPTIONS] [-- <SLOP>...]
 
-For more information try --help
+For more information try '--help'
 
 ```
 

diff --git a/examples/pacman.md b/examples/pacman.md
@@ -71,7 +71,7 @@ error: The argument '--search <search>...' cannot be used with '--info'
 
 Usage: pacman[EXE] {sync|--sync|-S} --search <search>... <package>...
 
-For more information try --help
+For more information try '--help'
 
 ```
 

diff --git a/examples/tutorial_builder/04_01_enum.md b/examples/tutorial_builder/04_01_enum.md
@@ -22,6 +22,6 @@ $ 04_01_enum medium
 error: "medium" isn't a valid value for '<MODE>'
   [possible values: fast, slow]
 
-For more information try --help
+For more information try '--help'
 
 ```
diff --git a/examples/tutorial_builder/04_01_possible.md b/examples/tutorial_builder/04_01_possible.md
@@ -22,6 +22,6 @@ $ 04_01_possible medium
 error: "medium" isn't a valid value for '<MODE>'
   [possible values: fast, slow]
 
-For more information try --help
+For more information try '--help'
 
 ```
diff --git a/examples/tutorial_builder/04_02_parse.md b/examples/tutorial_builder/04_02_parse.md
@@ -18,12 +18,12 @@ $ 04_02_parse foobar
 ? failed
 error: Invalid value "foobar" for '<PORT>': invalid digit found in string
 
-For more information try --help
+For more information try '--help'
 
 $ 04_02_parse_derive 0
 ? failed
 error: Invalid value "0" for '<PORT>': 0 is not in 1..=65535
 
-For more information try --help
+For more information try '--help'
 
 ```
diff --git a/examples/tutorial_builder/04_02_validate.md b/examples/tutorial_builder/04_02_validate.md
@@ -18,12 +18,12 @@ $ 04_02_validate foobar
 ? failed
 error: Invalid value "foobar" for '<PORT>': `foobar` isn't a port number
 
-For more information try --help
+For more information try '--help'
 
 $ 04_02_validate 0
 ? failed
 error: Invalid value "0" for '<PORT>': Port not in range 1-65535
 
-For more information try --help
+For more information try '--help'
 
 ```
diff --git a/examples/tutorial_builder/04_03_relations.md b/examples/tutorial_builder/04_03_relations.md
@@ -24,7 +24,7 @@ error: The following required arguments were not provided:
 
 Usage: 04_03_relations[EXE] <--set-ver <VER>|--major|--minor|--patch> [INPUT_FILE]
 
-For more information try --help
+For more information try '--help'
 
 $ 04_03_relations --major
 Version: 2.2.3
@@ -35,7 +35,7 @@ error: The argument '--major' cannot be used with '--minor'
 
 Usage: 04_03_relations[EXE] <--set-ver <VER>|--major|--minor|--patch> [INPUT_FILE]
 
-For more information try --help
+For more information try '--help'
 
 $ 04_03_relations --major -c config.toml
 ? failed
@@ -44,7 +44,7 @@ error: The following required arguments were not provided:
 
 Usage: 04_03_relations[EXE] -c <CONFIG> <--set-ver <VER>|--major|--minor|--patch> <INPUT_FILE|--spec-in <SPEC_IN>>
 
-For more information try --help
+For more information try '--help'
 
 $ 04_03_relations --major -c config.toml --spec-in input.txt
 Version: 2.2.3

diff --git a/examples/tutorial_builder/04_04_custom.md b/examples/tutorial_builder/04_04_custom.md
@@ -23,7 +23,7 @@ error: Can only modify one version field
 
 Usage: 04_04_custom[EXE] [OPTIONS] [INPUT_FILE]
 
-For more information try --help
+For more information try '--help'
 
 $ 04_04_custom --major
 Version: 2.2.3
@@ -34,7 +34,7 @@ error: Can only modify one version field
 
 Usage: 04_04_custom[EXE] [OPTIONS] [INPUT_FILE]
 
-For more information try --help
+For more information try '--help'
 
 $ 04_04_custom --major -c config.toml
 ? failed
@@ -43,7 +43,7 @@ error: INPUT_FILE or --spec-in is required when using --config
 
 Usage: 04_04_custom[EXE] [OPTIONS] [INPUT_FILE]
 
-For more information try --help
+For more information try '--help'
 
 $ 04_04_custom --major -c config.toml --spec-in input.txt
 Version: 2.2.3

diff --git a/examples/tutorial_derive/04_01_enum.md b/examples/tutorial_derive/04_01_enum.md
@@ -22,6 +22,6 @@ $ 04_01_enum_derive medium
 error: "medium" isn't a valid value for '<MODE>'
   [possible values: fast, slow]
 
-For more information try --help
+For more information try '--help'
 
 ```
diff --git a/examples/tutorial_derive/04_02_parse.md b/examples/tutorial_derive/04_02_parse.md
@@ -18,12 +18,12 @@ $ 04_02_parse_derive foobar
 ? failed
 error: Invalid value "foobar" for '<PORT>': invalid digit found in string
 
-For more information try --help
+For more information try '--help'
 
 $ 04_02_parse_derive 0
 ? failed
 error: Invalid value "0" for '<PORT>': 0 is not in 1..=65535
 
-For more information try --help
+For more information try '--help'
 
 ```
diff --git a/examples/tutorial_derive/04_02_validate.md b/examples/tutorial_derive/04_02_validate.md
@@ -18,12 +18,12 @@ $ 04_02_validate_derive foobar
 ? failed
 error: Invalid value "foobar" for '<PORT>': `foobar` isn't a port number
 
-For more information try --help
+For more information try '--help'
 
 $ 04_02_validate_derive 0
 ? failed
 error: Invalid value "0" for '<PORT>': Port not in range 1-65535
 
-For more information try --help
+For more information try '--help'
 
 ```
diff --git a/examples/tutorial_derive/04_03_relations.md b/examples/tutorial_derive/04_03_relations.md
@@ -24,7 +24,7 @@ error: The following required arguments were not provided:
 
 Usage: 04_03_relations_derive[EXE] <--set-ver <VER>|--major|--minor|--patch> [INPUT_FILE]
 
-For more information try --help
+For more information try '--help'
 
 $ 04_03_relations_derive --major
 Version: 2.2.3
@@ -35,7 +35,7 @@ error: The argument '--major' cannot be used with '--minor'
 
 Usage: 04_03_relations_derive[EXE] <--set-ver <VER>|--major|--minor|--patch> [INPUT_FILE]
 
-For more information try --help
+For more information try '--help'
 
 $ 04_03_relations_derive --major -c config.toml
 ? failed
@@ -44,7 +44,7 @@ error: The following required arguments were not provided:
 
 Usage: 04_03_relations_derive[EXE] -c <CONFIG> <--set-ver <VER>|--major|--minor|--patch> <INPUT_FILE|--spec-in <SPEC_IN>>
 
-For more information try --help
+For more information try '--help'
 
 $ 04_03_relations_derive --major -c config.toml --spec-in input.txt
 Version: 2.2.3

diff --git a/examples/tutorial_derive/04_04_custom.md b/examples/tutorial_derive/04_04_custom.md
@@ -23,7 +23,7 @@ error: Can only modify one version field
 
 Usage: clap [OPTIONS] [INPUT_FILE]
 
-For more information try --help
+For more information try '--help'
 
 $ 04_04_custom_derive --major
 Version: 2.2.3
@@ -34,7 +34,7 @@ error: Can only modify one version field
 
 Usage: clap [OPTIONS] [INPUT_FILE]
 
-For more information try --help
+For more information try '--help'
 
 $ 04_04_custom_derive --major -c config.toml
 ? failed
@@ -43,7 +43,7 @@ error: INPUT_FILE or --spec-in is required when using --config
 
 Usage: clap [OPTIONS] [INPUT_FILE]
 
-For more information try --help
+For more information try '--help'
 
 $ 04_04_custom_derive --major -c config.toml --spec-in input.txt
 Version: 2.2.3

diff --git a/examples/typed-derive.md b/examples/typed-derive.md
@@ -24,7 +24,7 @@ $ typed-derive -O plaid
 ? failed
 error: Invalid value "plaid" for '-O <OPTIMIZATION>': invalid digit found in string
 
-For more information try --help
+For more information try '--help'
 
 ```
 
@@ -44,7 +44,7 @@ $ typed-derive --bind localhost
 ? failed
 error: Invalid value "localhost" for '--bind <BIND>': invalid IP address syntax
 
-For more information try --help
+For more information try '--help'
 
 ```
 
@@ -57,7 +57,7 @@ $ typed-derive --sleep forever
 ? failed
 error: Invalid value "forever" for '--sleep <SLEEP>': expected number at 0
 
-For more information try --help
+For more information try '--help'
 
 ```
 
@@ -70,12 +70,12 @@ $ typed-derive -D Foo
 ? failed
 error: Invalid value "Foo" for '-D <DEFINES>': invalid KEY=value: no `=` found in `Foo`
 
-For more information try --help
+For more information try '--help'
 
 $ typed-derive -D Foo=Bar
 ? failed
 error: Invalid value "Foo=Bar" for '-D <DEFINES>': invalid digit found in string
 
-For more information try --help
+For more information try '--help'
 
 ```
diff --git a/src/error/format.rs b/src/error/format.rs
@@ -442,9 +442,9 @@ pub(crate) fn get_help_flag(cmd: &Command) -> Option<&'static str> {
 
 fn try_help(styled: &mut StyledStr, help: Option<&str>) {
     if let Some(help) = help {
-        styled.none("\n\nFor more information try ");
+        styled.none("\n\nFor more information try '");
         styled.good(help.to_owned());
-        styled.none("\n");
+        styled.none("'\n");
     } else {
         styled.none("\n");
     }

diff --git a/tests/builder/conflicts.rs b/tests/builder/conflicts.rs
@@ -277,7 +277,7 @@ error: The argument '--flag...' cannot be used with '-F'
 
 Usage: clap-test --flag... --long-option-2 <option2> <positional> <positional2> [positional3]...
 
-For more information try --help
+For more information try '--help'
 ";
 
     utils::assert_output(
@@ -295,7 +295,7 @@ error: The argument '-F' cannot be used with '--flag...'
 
 Usage: clap-test -F --long-option-2 <option2> <positional> <positional2> [positional3]...
 
-For more information try --help
+For more information try '--help'
 ";
 
     utils::assert_output(
@@ -313,7 +313,7 @@ error: The argument '--flag...' cannot be used with '-F'
 
 Usage: clap-test --flag... --long-option-2 <option2> <positional> <positional2> [positional3]...
 
-For more information try --help
+For more information try '--help'
 ";
 
     utils::assert_output(
@@ -331,7 +331,7 @@ error: The argument '-F' cannot be used with '--flag...'
 
 Usage: clap-test -F --long-option-2 <option2> <positional> <positional2> [positional3]...
 
-For more information try --help
+For more information try '--help'
 ";
 
     utils::assert_output(
@@ -351,7 +351,7 @@ error: The argument '--one' cannot be used with:
 
 Usage: three_conflicting_arguments --one
 
-For more information try --help
+For more information try '--help'
 ";
 
     let cmd = Command::new("three_conflicting_arguments")

diff --git a/tests/builder/default_vals.rs b/tests/builder/default_vals.rs
@@ -713,7 +713,7 @@ error: The following required arguments were not provided:
 
 Usage: bug <input>
 
-For more information try --help
+For more information try '--help'
 ",
         true,
     );