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

Merge pull request #3430 from AlyoshaVasilieva/validator-doc

Browse source 
Doc that `validator` takes &str, not String
This commit is contained in:
Ed Page 2022-02-10 06:06:10 -06:00 committed by GitHub
commit 3b4c44eccc
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
src/build/arg/mod.rs
View file

@ -1494,7 +1494,7 @@ impl<'help> Arg<'help> {
/// Perform a custom validation on the argument value.
///
/// You provide a closure
/// which accepts a [`String`] value, and return a [`Result`] where the [`Err(String)`] is a
/// which accepts a [`&str`] value, and return a [`Result`] where the [`Err(String)`] is a
/// message displayed to the user.
///
/// **NOTE:** The error message does *not* need to contain the `error:` portion, only the
@ -1525,7 +1525,6 @@ impl<'help> Arg<'help> {
/// assert!(res.is_ok());
/// assert_eq!(res.unwrap().value_of("file"), Some("some@file"));
/// ```
/// [`String`]: std::string::String
/// [`Result`]: std::result::Result
/// [`Err(String)`]: std::result::Result::Err
/// [`Arc`]: std::sync::Arc