Mirrors/clap
2
0
Fork 0
mirror of https://github.com/clap-rs/clap synced 2024-12-13 22:32:33 +00:00
Code Issues Projects Releases Packages Wiki Activity

docs(AllowHyphenValues): updates the docs to remove old limitations that no longer apply

Browse source
This commit is contained in:
Kevin K 2017-05-06 19:11:57 -04:00
parent 4048072021
commit 52d110df81
1 changed files with 2 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
src/app/settings.rs
View file

@ -162,11 +162,9 @@ pub enum AppSettings {
/// Specifies that leading hyphens are allowed in argument *values*, such as negative numbers
/// like `-10`. (which would otherwise be parsed as another flag or option)
///
/// **NOTE:** This can only be set application wide and not on a per argument basis.
///
/// **NOTE:** Use this setting with caution as it silences certain circumstances which would
/// otherwise be an error (such as accidentally forgetting to specify a value for leading
/// option)
/// option). It is preferred to set this on a per argument basis, via [`Arg::allow_hyphen_values`]
///
/// # Examples
///
@ -183,6 +181,7 @@ pub enum AppSettings {
/// assert_eq!(m.value_of("neg"), Some("-20"));
/// # ;
/// ```
/// [`Arg::allow_hyphen_values`]: ./struct.Arg.html#method.allow_hyphen_values
AllowLeadingHyphen,
/// Allows negative numbers to pass as values. This is similar to