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

feat(builder): Updated min_value and required docs

Browse source
This commit is contained in:
Andreas Backx 2022-05-14 02:34:26 +01:00
parent 02b4fed2aa
commit a678baa4f4
No known key found for this signature in database
GPG key ID: ADF0CBF83905D7B4
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/builder/arg.rs
View file

@ -1295,6 +1295,11 @@ impl<'help> Arg<'help> {
/// [`Arg::multiple_occurrences(true)`] because there is no way to determine the difference between multiple /// [`Arg::multiple_occurrences(true)`] because there is no way to determine the difference between multiple
/// occurrences and multiple values. /// 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 /// # Examples
/// ///
/// ```rust /// ```rust
@ -1340,6 +1345,7 @@ impl<'help> Arg<'help> {
/// assert_eq!(res.unwrap_err().kind(), ErrorKind::TooFewValues); /// assert_eq!(res.unwrap_err().kind(), ErrorKind::TooFewValues);
/// ``` /// ```
/// [`Arg::multiple_occurrences(true)`]: Arg::multiple_occurrences() /// [`Arg::multiple_occurrences(true)`]: Arg::multiple_occurrences()
/// [`Arg::required(true)`]: Arg::required()
#[inline] #[inline]
#[must_use] #[must_use]
pub fn min_values(mut self, qty: usize) -> Self { pub fn min_values(mut self, qty: usize) -> Self {