From 3c8db0e9be1d24edaad364359513cbb02abb4186 Mon Sep 17 00:00:00 2001 From: Kevin K Date: Fri, 19 Feb 2016 00:08:13 -0500 Subject: [PATCH] docs(AppSettings): clarifies that AppSettings do not propagate Closes #429 --- src/app/settings.rs | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/src/app/settings.rs b/src/app/settings.rs index 352272ac..f88b30ac 100644 --- a/src/app/settings.rs +++ b/src/app/settings.rs @@ -62,6 +62,9 @@ impl AppFlags { } /// Application level settings, which affect how `App` operates +/// +/// **NOTE:** When these settings are used, they apply only to current command, and are *not* +/// propagated down or up through child or parent subcommands #[derive(Debug, PartialEq, Copy, Clone)] pub enum AppSettings { /// Allows subcommands to override all requirements of the parent command. For example @@ -376,7 +379,8 @@ pub enum AppSettings { /// assert_eq!(m.value_of_os("arg").unwrap().as_bytes(), &[0xe9]); /// ``` AllowInvalidUtf8, - /// Specifies that leading hyphens are allowed in argument values, such as `-10` + /// Specifies that leading hyphens are allowed in argument *values*, such as negative numbers + /// `-10` /// /// **NOTE:** This can only be set application wide and not on a per argument basis. ///