Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2025-01-18 23:53:54 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs: fix affect/effect usage

Browse source
This commit is contained in:
cherryblossom000 2021-10-21 19:29:08 +11:00 committed by GitHub
parent c4dfb1aede
commit 5555416f45
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/build/arg/mod.rs
View file

@ -2748,7 +2748,7 @@ impl<'help> Arg<'help> {
/// used at runtime. /// used at runtime.
/// ///
/// **NOTE:** This setting is perfectly compatible with [`Arg::default_value_if`] but slightly /// **NOTE:** This setting is perfectly compatible with [`Arg::default_value_if`] but slightly
/// different. `Arg::default_value` *only* takes affect when the user has not provided this arg /// different. `Arg::default_value` *only* takes effect when the user has not provided this arg
/// at runtime. `Arg::default_value_if` however only takes effect when the user has not provided /// at runtime. `Arg::default_value_if` however only takes effect when the user has not provided
/// a value at runtime **and** these other conditions are met as well. If you have set /// a value at runtime **and** these other conditions are met as well. If you have set
/// `Arg::default_value` and `Arg::default_value_if`, and the user **did not** provide this arg /// `Arg::default_value` and `Arg::default_value_if`, and the user **did not** provide this arg
@ -2947,8 +2947,8 @@ impl<'help> Arg<'help> {
/// present at runtime **and** have the value `val`. /// present at runtime **and** have the value `val`.
/// ///
/// **NOTE:** This setting is perfectly compatible with [`Arg::default_value`] but slightly /// **NOTE:** This setting is perfectly compatible with [`Arg::default_value`] but slightly
/// different. `Arg::default_value` *only* takes affect when the user has not provided this arg /// different. `Arg::default_value` *only* takes effect when the user has not provided this arg
/// at runtime. This setting however only takes affect when the user has not provided a value at /// at runtime. This setting however only takes effect when the user has not provided a value at
/// runtime **and** these other conditions are met as well. If you have set `Arg::default_value` /// runtime **and** these other conditions are met as well. If you have set `Arg::default_value`
/// and `Arg::default_value_if`, and the user **did not** provide this arg at runtime, nor were /// and `Arg::default_value_if`, and the user **did not** provide this arg at runtime, nor were
/// the conditions met for `Arg::default_value_if`, the `Arg::default_value` will be applied. /// the conditions met for `Arg::default_value_if`, the `Arg::default_value` will be applied.
@ -3414,7 +3414,7 @@ impl<'help> Arg<'help> {
/// **NOTE:** This setting will imply [`crate::AppSettings::DontCollapseArgsInUsage`] because failing /// **NOTE:** This setting will imply [`crate::AppSettings::DontCollapseArgsInUsage`] because failing
/// to set this can make the usage string very confusing. /// to set this can make the usage string very confusing.
/// ///
/// **NOTE**: This setting only applies to positional arguments, and has no affect on OPTIONS /// **NOTE**: This setting only applies to positional arguments, and has no effect on OPTIONS
/// ///
/// **NOTE:** Setting this requires [`crate::ArgSettings::TakesValue`] /// **NOTE:** Setting this requires [`crate::ArgSettings::TakesValue`]
/// ///