From a678baa4f46cc79eed6b7fecafe0dff751198045 Mon Sep 17 00:00:00 2001 From: Andreas Backx Date: Sat, 14 May 2022 02:34:26 +0100 Subject: [PATCH] feat(builder): Updated min_value and required docs --- src/builder/arg.rs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/builder/arg.rs b/src/builder/arg.rs index 91fe5b4a9be..07ece27ac57 100644 --- a/src/builder/arg.rs +++ b/src/builder/arg.rs @@ -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 @@ -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 {