docs(AppSettings): clarifies that AppSettings do not propagate

Closes #429
This commit is contained in:
Kevin K 2016-02-19 00:08:13 -05:00
parent 60c042481f
commit 3c8db0e9be

View file

@ -62,6 +62,9 @@ impl AppFlags {
} }
/// Application level settings, which affect how `App` operates /// 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)] #[derive(Debug, PartialEq, Copy, Clone)]
pub enum AppSettings { pub enum AppSettings {
/// Allows subcommands to override all requirements of the parent command. For example /// 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]); /// assert_eq!(m.value_of_os("arg").unwrap().as_bytes(), &[0xe9]);
/// ``` /// ```
AllowInvalidUtf8, 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. /// **NOTE:** This can only be set application wide and not on a per argument basis.
/// ///