docs: Clarify behavior of Arg::multiple with options.

This commit is contained in:
Jimmy Cuadra 2015-10-29 22:40:47 -07:00
parent c1f66b5de7
commit 434f497ab6

View file

@ -677,13 +677,15 @@ impl<'n, 'l, 'h, 'g, 'p, 'r> Arg<'n, 'l, 'h, 'g, 'p, 'r> {
self self
} }
/// Specifies if the flag may appear more than once such as for multiple debugging /// Specifies that the flag or option may appear more than once. For flags, this results
/// levels (as an example). `-ddd` for three levels of debugging, or `-d -d -d`. /// in the number of occurrences of the flag being recorded. For example `-ddd` would count as
/// When this is set to `true` you receive the number of occurrences the user supplied /// three occurrences. The form `-d -d -d` would also be recognized as three occurrences. For
/// of a particular flag at runtime. /// options, more than one value may be provided. The forms `--optional foo --optional bar`,
/// `--optional foo bar` and `-ofoo -obar` are all recognized, assuming the relevant `short`
/// and `long` option names have been set.
/// ///
/// **NOTE:** When setting this, any `takes_value` or `index` values you set /// **NOTE:** When setting this, `index` is ignored as it only makes sense for positional
/// are ignored as flags cannot have a values or an `index`. /// arguments.
/// ///
/// ///
/// # Examples /// # Examples