Merge pull request #44 from epage/examples

docs: Prefer `global_setting`

README.md

@@ -135,7 +135,7 @@ The first example shows the simplest way to use `clap`, by defining a struct. If
 //
 // This example demonstrates clap's full 'custom derive' style of creating arguments which is the
 // simplest method of use, but sacrifices some flexibility.
-use clap::{AppSettings, Parser};
+use clap::Parser;
 
 /// This doc string acts as a help message when the user runs '--help'
 /// as do all doc strings on fields

clap_derive/examples/subcommand_aliases.rs

@@ -4,7 +4,7 @@ use clap::{AppSettings, Parser};
 
 #[derive(Parser, Debug)]
 // https://docs.rs/clap/2/clap/enum.AppSettings.html#variant.InferSubcommands
-#[clap(setting = AppSettings::InferSubcommands)]
+#[clap(global_setting = AppSettings::InferSubcommands)]
 enum Opt {
     // https://docs.rs/clap/2/clap/struct.App.html#method.alias
     #[clap(alias = "foobar")]

src/build/app/mod.rs

@@ -935,14 +935,14 @@ impl<'help> App<'help> {
     /// # use clap::{App, AppSettings};
     /// App::new("myprog")
     ///     .setting(AppSettings::SubcommandRequired)
-    ///     .setting(AppSettings::WaitOnError)
+    ///     .setting(AppSettings::AllowLeadingHyphen)
     /// # ;
     /// ```
     /// or
     /// ```no_run
     /// # use clap::{App, AppSettings};
     /// App::new("myprog")
-    ///     .setting(AppSettings::SubcommandRequired | AppSettings::WaitOnError)
+    ///     .setting(AppSettings::SubcommandRequired | AppSettings::AllowLeadingHyphen)
     /// # ;
     /// ```
     #[inline]
@@ -964,14 +964,14 @@ impl<'help> App<'help> {
     /// # use clap::{App, AppSettings};
     /// App::new("myprog")
     ///     .unset_setting(AppSettings::SubcommandRequired)
-    ///     .unset_setting(AppSettings::WaitOnError)
+    ///     .setting(AppSettings::AllowLeadingHyphen)
     /// # ;
     /// ```
     /// or
     /// ```no_run
     /// # use clap::{App, AppSettings};
     /// App::new("myprog")
-    ///     .unset_setting(AppSettings::SubcommandRequired | AppSettings::WaitOnError)
+    ///     .unset_setting(AppSettings::SubcommandRequired | AppSettings::AllowLeadingHyphen)
     /// # ;
     /// ```
     #[inline]
@@ -994,7 +994,7 @@ impl<'help> App<'help> {
     /// ```no_run
     /// # use clap::{App, AppSettings};
     /// App::new("myprog")
-    ///     .global_setting(AppSettings::SubcommandRequired)
+    ///     .global_setting(AppSettings::AllowNegativeNumbers)
     /// # ;
     /// ```
     #[inline]

src/build/app/settings.rs

@@ -268,7 +268,7 @@ pub enum AppSettings {
     /// ```rust
     /// # use clap::{App, Arg, AppSettings};
     /// let res = App::new("myprog")
-    ///     .setting(AppSettings::AllowNegativeNumbers)
+    ///     .global_setting(AppSettings::AllowNegativeNumbers)
     ///     .arg(Arg::new("num"))
     ///     .try_get_matches_from(vec![
     ///         "myprog", "-20"
@@ -547,7 +547,7 @@ pub enum AppSettings {
     /// ```no_run
     /// # use clap::{App, Arg, AppSettings};
     /// App::new("myprog")
-    ///     .setting(AppSettings::DontCollapseArgsInUsage)
+    ///     .global_setting(AppSettings::DontCollapseArgsInUsage)
     ///     .get_matches();
     /// ```
     DontCollapseArgsInUsage,
@@ -645,7 +645,7 @@ pub enum AppSettings {
     /// ```no_run
     /// # use clap::{App, Arg, AppSettings};
     /// App::new("myprog")
-    ///     .setting(AppSettings::DeriveDisplayOrder)
+    ///     .global_setting(AppSettings::DeriveDisplayOrder)
     ///     .get_matches();
     /// ```
     ///
@@ -750,7 +750,7 @@ pub enum AppSettings {
     /// # use clap::{App, Arg, AppSettings};
     /// App::new("myprog")
     ///     .version("v1.1")
-    ///     .setting(AppSettings::PropagateVersion)
+    ///     .global_setting(AppSettings::PropagateVersion)
     ///     .subcommand(App::new("test"))
     ///     .get_matches();
     /// // running `$ myprog test --version` will display
@@ -803,7 +803,7 @@ pub enum AppSettings {
     /// ```rust
     /// # use clap::{App, Arg, AppSettings};
     /// App::new("myprog")
-    ///     .setting(AppSettings::HelpExpected)
+    ///     .global_setting(AppSettings::HelpExpected)
     ///     .arg(
     ///         Arg::new("foo").help("It does foo stuff")
     ///         // As required via AppSettings::HelpExpected, a help message was supplied
@@ -816,7 +816,7 @@ pub enum AppSettings {
     /// ```rust,no_run
     /// # use clap::{App, Arg, AppSettings};
     /// App::new("myapp")
-    ///     .setting(AppSettings::HelpExpected)
+    ///     .global_setting(AppSettings::HelpExpected)
     ///     .arg(
     ///         Arg::new("foo")
     ///         // Someone forgot to put .about("...") here
@@ -835,7 +835,7 @@ pub enum AppSettings {
     /// ```rust
     /// # use clap::{App, arg, AppSettings};
     /// let app = App::new("app")
-    ///   .setting(AppSettings::IgnoreErrors)
+    ///   .global_setting(AppSettings::IgnoreErrors)
     ///   .arg(arg!(-c --config <FILE> "Sets a custom config file").required(false))
     ///   .arg(arg!(-x --stuff <FILE> "Sets a custom stuff file").required(false))
     ///   .arg(arg!(f: -f "Flag"));
@@ -869,7 +869,7 @@ pub enum AppSettings {
     /// ```no_run
     /// # use clap::{App, Arg, AppSettings};
     /// let m = App::new("prog")
-    ///     .setting(AppSettings::InferSubcommands)
+    ///     .global_setting(AppSettings::InferSubcommands)
     ///     .subcommand(App::new("test"))
     ///     .get_matches_from(vec![
     ///         "prog", "te"
@@ -921,7 +921,7 @@ pub enum AppSettings {
     /// ```no_run
     /// # use clap::{App, Arg, AppSettings};
     /// App::new("myprog")
-    ///     .setting(AppSettings::NextLineHelp)
+    ///     .global_setting(AppSettings::NextLineHelp)
     ///     .get_matches();
     /// ```
     NextLineHelp,
@@ -1004,7 +1004,7 @@ pub enum AppSettings {
     /// ```rust
     /// # use clap::{App, Arg, AppSettings};
     /// App::new("myprog")
-    ///     .setting(AppSettings::UseLongFormatForHelpSubcommand)
+    ///     .global_setting(AppSettings::UseLongFormatForHelpSubcommand)
     ///     .subcommand(App::new("test")
     ///         .arg(Arg::new("foo")
     ///             .help("short form about message")
@@ -1075,7 +1075,7 @@ pub enum AppSettings {
     /// ```rust
     /// # use clap::{App, Arg, AppSettings};
     /// App::new("myprog")
-    ///     .setting(AppSettings::WaitOnError);
+    ///     .global_setting(AppSettings::WaitOnError);
     /// ```
     WaitOnError,