Merge pull request #28 from hartwork/improve-help-output

Document positional arguments in --help output
hartwork · Jun 18, 2023 · c6e4221 · c6e4221
2 parents 2f75aae + 4bfdd15
commit c6e4221
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/src/command_line_parser.rs b/src/command_line_parser.rs
@@ -78,7 +78,11 @@ pub fn command() -> Command {
  .num_args(0..)
  .help("Service to test via the TCP protocol; can be passed multiple times"),
  )
- .arg(Arg::new("command").num_args(0..))
+ .arg(
+ Arg::new("command")
+ .num_args(0..)
+ .help("Command to run after waiting;\nincludes command arguments, resolved against ${PATH}"),
+ )
 }
 
 #[cfg(test)]

diff --git a/src/main.rs b/src/main.rs
@@ -99,7 +99,8 @@ fn test_middle_main() {
  Usage: rust-for-it [OPTIONS] [command]...
 
  Arguments:
- [command]... 
+ [command]... Command to run after waiting;
+ includes command arguments, resolved against ${PATH}
 
  Options:
  -q, --quiet Do not output any status messages