Skip to content

Commit

Permalink
Merge pull request #3728 from AndreasBackx/issue/3259
Browse files Browse the repository at this point in the history
feat(builder): Updated min_value and required docs
  • Loading branch information
epage committed May 16, 2022
2 parents 02b4fed + a678baa commit 740bb39
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/builder/arg.rs
Expand Up @@ -1295,6 +1295,11 @@ impl<'help> Arg<'help> {
/// [`Arg::multiple_occurrences(true)`] because there is no way to determine the difference between multiple
/// occurrences and multiple values.
///
/// **NOTE:** Passing a non-zero value is not the same as specifying [`Arg::required(true)`].
/// This is due to min and max validation only being performed for present arguments,
/// marking them as required will thus perform validation and a min value of 1
/// is unnecessary, ignored if not required.
///
/// # Examples
///
/// ```rust
Expand Down Expand Up @@ -1340,6 +1345,7 @@ impl<'help> Arg<'help> {
/// assert_eq!(res.unwrap_err().kind(), ErrorKind::TooFewValues);
/// ```
/// [`Arg::multiple_occurrences(true)`]: Arg::multiple_occurrences()
/// [`Arg::required(true)`]: Arg::required()
#[inline]
#[must_use]
pub fn min_values(mut self, qty: usize) -> Self {
Expand Down

0 comments on commit 740bb39

Please sign in to comment.