Merge pull request google#106 from aminya/help-short-alias

google#106
jirutka · Jan 9, 2023 · 663a9ed · 663a9ed
2 parents 728d143 + edc0191
commit 663a9ed
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -51,7 +51,7 @@ Options:
   -j, --jump        whether or not to jump
   --height          how high to go
   --pilot-nickname  an optional nickname for the pilot
-  --help            display usage information
+  -h, --help        display usage information
 ```
 
 The resulting program can then be used in any of these ways:

diff --git a/argh/src/lib.rs b/argh/src/lib.rs
@@ -402,7 +402,7 @@ pub trait FromArgs: Sized {
     /// Command to manage a classroom.
     ///
     /// Options:
-    ///   --help            display usage information
+    ///   -h, --help        display usage information
     ///
     /// Commands:
     ///   list              list all the classes.
@@ -426,7 +426,7 @@ pub trait FromArgs: Sized {
     ///
     /// Options:
     ///   --teacher-name    list classes for only this teacher.
-    ///   --help            display usage information
+    ///   -h, --help        display usage information
     /// "#.to_string(),
     ///        status: Ok(()),
     ///     },
@@ -568,7 +568,7 @@ pub trait FromArgs: Sized {
     /// Command to manage a classroom.
     ///
     /// Options:
-    ///   --help            display usage information
+    ///   -h, --help        display usage information
     ///
     /// Commands:
     ///   list              list all the classes.
@@ -885,7 +885,7 @@ pub fn parse_struct_args(
 
     'parse_args: while let Some(&next_arg) = remaining_args.first() {
         remaining_args = &remaining_args[1..];
-        if (next_arg == "--help" || next_arg == "help") && !options_ended {
+        if (next_arg == "--help" || next_arg == "help" || next_arg == "-h") && !options_ended {
             help = true;
             continue;
         }

diff --git a/argh/tests/lib.rs b/argh/tests/lib.rs
@@ -256,7 +256,7 @@ Short description
 Options:
   --s               a switch with a description that is spread across a number
                     of lines of comments.
-  --help            display usage information
+  -h, --help        display usage information
 "###,
     );
 }
@@ -393,7 +393,7 @@ Woot
 
 Options:
   -n, --n           fooey
-  --help            display usage information
+  -h, --help        display usage information
 "###,
         );
     }
@@ -415,7 +415,7 @@ Woot
 
 Options:
   --option-name     fooey
-  --help            display usage information
+  -h, --help        display usage information
 "###,
         );
     }
@@ -453,7 +453,7 @@ Positional Arguments:
   b                 fooey
 
 Options:
-  --help            display usage information
+  -h, --help        display usage information
 "###,
         );
     }
@@ -537,7 +537,7 @@ Positional Arguments:
 Options:
   --b               woo
   --c               stuff
-  --help            display usage information
+  -h, --help        display usage information
 "###,
         );
     }
@@ -946,7 +946,7 @@ mod fuchsia_commandline_tools_rubric {
 A type for testing `--help`/`help`
 
 Options:
-  --help            display usage information
+  -h, --help        display usage information
 
 Commands:
   first             First subcommmand for testing `help`.
@@ -957,7 +957,7 @@ Commands:
 First subcommmand for testing `help`.
 
 Options:
-  --help            display usage information
+  -h, --help        display usage information
 
 Commands:
   second            Second subcommand for testing `help`.
@@ -968,7 +968,7 @@ Commands:
 Second subcommand for testing `help`.
 
 Options:
-  --help            display usage information
+  -h, --help        display usage information
 "###;
 
     #[test]
@@ -1149,7 +1149,7 @@ Options:
                     documentation
   -s, --scribble    write <scribble> repeatedly
   -v, --verbose     say more. Defaults to $BLAST_VERBOSE.
-  --help            display usage information
+  -h, --help        display usage information
 
 Commands:
   blow-up           explosively separate
@@ -1189,7 +1189,7 @@ Positional Arguments:
   name
 
 Options:
-  --help            display usage information
+  -h, --help        display usage information
 "###,
         );
     }
@@ -1219,7 +1219,7 @@ Positional Arguments:
   two               this one is real
 
 Options:
-  --help            display usage information
+  -h, --help        display usage information
 "###,
         );
     }
@@ -1582,7 +1582,7 @@ Woot
 
 Options:
   -n, --n           fooey
-  --help            display usage information
+  -h, --help        display usage information
 "###
             .to_owned(),
             status: Ok(()),

diff --git a/argh_derive/src/help.rs b/argh_derive/src/help.rs
@@ -84,7 +84,7 @@ pub(crate) fn help(
         option_description(errors, &mut format_lit, option);
     }
     // Also include "help"
-    option_description_format(&mut format_lit, None, "--help", "display usage information");
+    option_description_format(&mut format_lit, None, "-h, --help", "display usage information");
 
     let subcommand_calculation;
     let subcommand_format_arg;