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

docs: Link to exit code info

Browse source
This commit is contained in:
Martin Pool 2024-01-15 14:27:50 -08:00
parent b250c0b5f5
commit 8c83971b8c
No known key found for this signature in database
GPG key ID: E0A11EED112D015A
2 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
clap_builder/src/builder/command.rs
View file

@ -588,7 +588,7 @@ impl Command {
Error::raw(kind, message).format(self)
}
/// Parse [`env::args_os`], exiting on failure.
/// Parse [`env::args_os`], [exiting][Error::exit] on failure.
///
/// # Panics
///
@ -610,7 +610,7 @@ impl Command {
self.get_matches_from(env::args_os())
}
/// Parse [`env::args_os`], exiting on failure.
/// Parse [`env::args_os`], [exiting][Error::exit] on failure.
///
/// Like [`Command::get_matches`] but doesn't consume the `Command`.
///
@ -670,7 +670,7 @@ impl Command {
self.try_get_matches_from(env::args_os())
}
/// Parse the specified arguments, exiting on failure.
/// Parse the specified arguments, [exiting][Error::exit] on failure.
///
/// **NOTE:** The first argument will be parsed as the binary name unless
/// [`Command::no_binary_name`] is used.

6
clap_builder/src/derive.rs
View file

@ -22,7 +22,7 @@ use std::ffi::OsString;
///
/// **NOTE:** Deriving requires the `derive` feature flag
pub trait Parser: FromArgMatches + CommandFactory + Sized {
/// Parse from `std::env::args_os()`, exit on error
/// Parse from `std::env::args_os()`, [exit][Error::exit] on error.
fn parse() -> Self {
let mut matches = <Self as CommandFactory>::command().get_matches();
let res = <Self as FromArgMatches>::from_arg_matches_mut(&mut matches)
@ -43,7 +43,7 @@ pub trait Parser: FromArgMatches + CommandFactory + Sized {
<Self as FromArgMatches>::from_arg_matches_mut(&mut matches).map_err(format_error::<Self>)
}
/// Parse from iterator, exit on error
/// Parse from iterator, [exit][Error::exit] on error.
fn parse_from<I, T>(itr: I) -> Self
where
I: IntoIterator<Item = T>,
@ -72,7 +72,7 @@ pub trait Parser: FromArgMatches + CommandFactory + Sized {
<Self as FromArgMatches>::from_arg_matches_mut(&mut matches).map_err(format_error::<Self>)
}
/// Update from iterator, exit on error
/// Update from iterator, [exit][Error::exit] on error.
fn update_from<I, T>(&mut self, itr: I)
where
I: IntoIterator<Item = T>,