Merge pull request #3343 from epage/sub

docs(tutorial): Talk about required/optional subcommands
clap-rs · Jan 25, 2022 · b88faad · b88faad
2 parents ea7699c + f32d640
commit b88faad
Show file tree

Hide file tree

Showing 3 changed files with 43 additions and 33 deletions.
diff --git a/examples/tutorial_builder/03_04_subcommands.rs b/examples/tutorial_builder/03_04_subcommands.rs
@@ -17,6 +17,8 @@ fn main() {
             "'myapp add' was used, name is: {:?}",
             sub_matches.value_of("NAME")
         ),
-        _ => unreachable!(),
+        _ => unreachable!(
+            "Exhausted list of subcommands and SubcommandRequiredElseHelp prevents `None`"
+        ),
     }
 }
diff --git a/examples/tutorial_builder/README.md b/examples/tutorial_builder/README.md
@@ -272,22 +272,6 @@ subcommands.
 
 [Example:](03_04_subcommands.rs)
 ```console
-$ 03_04_subcommands
-? failed
-clap [..]
-A simple to use, efficient, and full-featured Command Line Argument Parser
-
-USAGE:
-    03_04_subcommands[EXE] <SUBCOMMAND>
-
-OPTIONS:
-    -h, --help       Print help information
-    -V, --version    Print version information
-
-SUBCOMMANDS:
-    add     Adds files to myapp
-    help    Print this message or the help of the given subcommand(s)
-
 $ 03_04_subcommands help
 clap [..]
 A simple to use, efficient, and full-featured Command Line Argument Parser
@@ -322,6 +306,26 @@ $ 03_04_subcommands add bob
 
 ```
 
+Because we set `AppSettings::SubcommandRequiredElseHelp`:
+```console
+$ 03_04_subcommands
+? failed
+clap [..]
+A simple to use, efficient, and full-featured Command Line Argument Parser
+
+USAGE:
+    03_04_subcommands[EXE] <SUBCOMMAND>
+
+OPTIONS:
+    -h, --help       Print help information
+    -V, --version    Print version information
+
+SUBCOMMANDS:
+    add     Adds files to myapp
+    help    Print this message or the help of the given subcommand(s)
+
+```
+
 Because we set `AppSettings::PropagateVersion`:
 ```console
 $ 03_04_subcommands --version

diff --git a/examples/tutorial_derive/README.md b/examples/tutorial_derive/README.md
@@ -274,22 +274,6 @@ subcommands.
 
 [Example:](03_04_subcommands.rs)
 ```console
-$ 03_04_subcommands_derive
-? failed
-clap [..]
-A simple to use, efficient, and full-featured Command Line Argument Parser
-
-USAGE:
-    03_04_subcommands_derive[EXE] <SUBCOMMAND>
-
-OPTIONS:
-    -h, --help       Print help information
-    -V, --version    Print version information
-
-SUBCOMMANDS:
-    add     Adds files to myapp
-    help    Print this message or the help of the given subcommand(s)
-
 $ 03_04_subcommands_derive help
 clap [..]
 A simple to use, efficient, and full-featured Command Line Argument Parser
@@ -324,6 +308,26 @@ $ 03_04_subcommands_derive add bob
 
 ```
 
+Because we used `command: Commands` instead of `command: Option<Commands>`:
+```console
+$ 03_04_subcommands_derive
+? failed
+clap [..]
+A simple to use, efficient, and full-featured Command Line Argument Parser
+
+USAGE:
+    03_04_subcommands_derive[EXE] <SUBCOMMAND>
+
+OPTIONS:
+    -h, --help       Print help information
+    -V, --version    Print version information
+
+SUBCOMMANDS:
+    add     Adds files to myapp
+    help    Print this message or the help of the given subcommand(s)
+
+```
+
 Because we set `AppSettings::PropagateVersion`:
 ```console
 $ 03_04_subcommands_derive --version