fix(help): Use standard alternate syntax for subcommands

clap-rs · Feb 15, 2022 · 3475555 · 3475555
1 parent 9a83ada
commit 3475555
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 7 deletions.
diff --git a/examples/pacman.md b/examples/pacman.md
@@ -58,7 +58,7 @@ pacman[EXE]-sync
 Synchronize packages.
 
 USAGE:
-    pacman[EXE] {sync, --sync, -S} [OPTIONS] [--] [package]...
+    pacman[EXE] {sync|--sync|-S} [OPTIONS] [--] [package]...
 
 ARGS:
     <package>...    packages
@@ -77,7 +77,7 @@ $ pacman -S -s foo -i bar
 error: The argument '--search <search>...' cannot be used with '--info'
 
 USAGE:
-    pacman[EXE] {sync, --sync, -S} --search <search>... <package>...
+    pacman[EXE] {sync|--sync|-S} --search <search>... <package>...
 
 For more information try --help
 

diff --git a/src/build/app.rs b/src/build/app.rs
@@ -4003,11 +4003,11 @@ impl<'help> App<'help> {
         let mut sc_names = sc.name.clone();
         let mut flag_subcmd = false;
         if let Some(l) = sc.long_flag {
-            write!(sc_names, ", --{}", l).unwrap();
+            write!(sc_names, "|--{}", l).unwrap();
             flag_subcmd = true;
         }
         if let Some(s) = sc.short_flag {
-            write!(sc_names, ", -{}", s).unwrap();
+            write!(sc_names, "|-{}", s).unwrap();
             flag_subcmd = true;
         }
 

diff --git a/tests/builder/flag_subcommands.rs b/tests/builder/flag_subcommands.rs
@@ -453,7 +453,7 @@ static FLAG_SUBCOMMAND_HELP: &str = "pacman-query
 Query the package database.
 
 USAGE:
-    pacman {query, --query, -Q} [OPTIONS]
+    pacman {query|--query|-Q} [OPTIONS]
 
 OPTIONS:
     -h, --help                  Print help information
@@ -507,7 +507,7 @@ static FLAG_SUBCOMMAND_NO_SHORT_HELP: &str = "pacman-query
 Query the package database.
 
 USAGE:
-    pacman {query, --query} [OPTIONS]
+    pacman {query|--query} [OPTIONS]
 
 OPTIONS:
     -h, --help                  Print help information
@@ -560,7 +560,7 @@ static FLAG_SUBCOMMAND_NO_LONG_HELP: &str = "pacman-query
 Query the package database.
 
 USAGE:
-    pacman {query, -Q} [OPTIONS]
+    pacman {query|-Q} [OPTIONS]
 
 OPTIONS:
     -h, --help                  Print help information