From 78b2b44b950e2d4cec130c2f88b6d28b8201a5f5 Mon Sep 17 00:00:00 2001 From: Ed Page Date: Mon, 8 Aug 2022 14:07:57 -0500 Subject: [PATCH] docs(tutorial): Focus on actions, not macros --- examples/tutorial_builder/03_01_flag_count.rs | 9 +++++++-- examples/tutorial_builder/03_02_option.md | 2 +- examples/tutorial_builder/03_02_option.rs | 4 ++-- examples/tutorial_builder/03_03_positional.md | 8 ++++---- examples/tutorial_builder/03_03_positional.rs | 6 +++--- examples/tutorial_builder/03_05_default_values.md | 4 ++-- examples/tutorial_builder/03_05_default_values.rs | 2 +- 7 files changed, 20 insertions(+), 15 deletions(-) diff --git a/examples/tutorial_builder/03_01_flag_count.rs b/examples/tutorial_builder/03_01_flag_count.rs index 059a3f30..8e621251 100644 --- a/examples/tutorial_builder/03_01_flag_count.rs +++ b/examples/tutorial_builder/03_01_flag_count.rs @@ -1,8 +1,13 @@ -use clap::{arg, command, ArgAction}; +use clap::{command, Arg, ArgAction}; fn main() { let matches = command!() // requires `cargo` feature - .arg(arg!(-v - -verbose).action(ArgAction::Count)) + .arg( + Arg::new("verbose") + .short('v') + .long("verbose") + .action(ArgAction::Count), + ) .get_matches(); println!( diff --git a/examples/tutorial_builder/03_02_option.md b/examples/tutorial_builder/03_02_option.md index 55466678..3ee06eb7 100644 --- a/examples/tutorial_builder/03_02_option.md +++ b/examples/tutorial_builder/03_02_option.md @@ -7,7 +7,7 @@ USAGE: 03_02_option[EXE] [OPTIONS] OPTIONS: - -n, --name + -n, --name -h, --help Print help information -V, --version Print version information diff --git a/examples/tutorial_builder/03_02_option.rs b/examples/tutorial_builder/03_02_option.rs index 18824456..e9ba3e41 100644 --- a/examples/tutorial_builder/03_02_option.rs +++ b/examples/tutorial_builder/03_02_option.rs @@ -1,8 +1,8 @@ -use clap::{arg, command}; +use clap::{command, Arg}; fn main() { let matches = command!() // requires `cargo` feature - .arg(arg!(-n --name ).required(false)) + .arg(Arg::new("name").short('n').long("name")) .get_matches(); println!("name: {:?}", matches.get_one::("name")); diff --git a/examples/tutorial_builder/03_03_positional.md b/examples/tutorial_builder/03_03_positional.md index a3d7b8cf..63eab23c 100644 --- a/examples/tutorial_builder/03_03_positional.md +++ b/examples/tutorial_builder/03_03_positional.md @@ -4,19 +4,19 @@ clap [..] A simple to use, efficient, and full-featured Command Line Argument Parser USAGE: - 03_03_positional[EXE] [NAME] + 03_03_positional[EXE] [name] ARGS: - + OPTIONS: -h, --help Print help information -V, --version Print version information $ 03_03_positional -NAME: None +name: None $ 03_03_positional bob -NAME: Some("bob") +name: Some("bob") ``` diff --git a/examples/tutorial_builder/03_03_positional.rs b/examples/tutorial_builder/03_03_positional.rs index 0c3a5f03..f652d27c 100644 --- a/examples/tutorial_builder/03_03_positional.rs +++ b/examples/tutorial_builder/03_03_positional.rs @@ -1,9 +1,9 @@ -use clap::{arg, command}; +use clap::{command, Arg}; fn main() { let matches = command!() // requires `cargo` feature - .arg(arg!([NAME])) + .arg(Arg::new("name")) .get_matches(); - println!("NAME: {:?}", matches.get_one::("NAME")); + println!("name: {:?}", matches.get_one::("name")); } diff --git a/examples/tutorial_builder/03_05_default_values.md b/examples/tutorial_builder/03_05_default_values.md index 7b6c0307..95465bf7 100644 --- a/examples/tutorial_builder/03_05_default_values.md +++ b/examples/tutorial_builder/03_05_default_values.md @@ -14,9 +14,9 @@ OPTIONS: -V, --version Print version information $ 03_05_default_values -NAME: "alice" +name: "alice" $ 03_05_default_values bob -NAME: "bob" +name: "bob" ``` diff --git a/examples/tutorial_builder/03_05_default_values.rs b/examples/tutorial_builder/03_05_default_values.rs index cb3e3831..b11042c3 100644 --- a/examples/tutorial_builder/03_05_default_values.rs +++ b/examples/tutorial_builder/03_05_default_values.rs @@ -6,7 +6,7 @@ fn main() { .get_matches(); println!( - "NAME: {:?}", + "name: {:?}", matches .get_one::("NAME") .expect("default ensures there is always a value")