mirror of
https://github.com/clap-rs/clap
synced 2024-12-12 22:02:35 +00:00
style(docs): Resolve warnings
This commit is contained in:
parent
14fd853fb9
commit
28425e484f
5 changed files with 8 additions and 8 deletions
|
@ -875,7 +875,7 @@ impl Arg {
|
||||||
impl Arg {
|
impl Arg {
|
||||||
/// Specify how to react to an argument when parsing it.
|
/// Specify how to react to an argument when parsing it.
|
||||||
///
|
///
|
||||||
/// [ArgAction][crate::ArgAction] controls things like
|
/// [ArgAction] controls things like
|
||||||
/// - Overwriting previous values with new ones
|
/// - Overwriting previous values with new ones
|
||||||
/// - Appending new values to all previous ones
|
/// - Appending new values to all previous ones
|
||||||
/// - Counting how many times a flag occurs
|
/// - Counting how many times a flag occurs
|
||||||
|
@ -1260,7 +1260,7 @@ impl Arg {
|
||||||
|
|
||||||
/// Provide the shell a hint about how to complete this argument.
|
/// Provide the shell a hint about how to complete this argument.
|
||||||
///
|
///
|
||||||
/// See [`ValueHint`][crate::ValueHint] for more information.
|
/// See [`ValueHint`] for more information.
|
||||||
///
|
///
|
||||||
/// **NOTE:** implicitly sets [`Arg::action(ArgAction::Set)`].
|
/// **NOTE:** implicitly sets [`Arg::action(ArgAction::Set)`].
|
||||||
///
|
///
|
||||||
|
|
|
@ -1070,7 +1070,7 @@ impl Command {
|
||||||
/// Replace prior occurrences of arguments rather than error
|
/// Replace prior occurrences of arguments rather than error
|
||||||
///
|
///
|
||||||
/// For any argument that would conflict with itself by default (e.g.
|
/// For any argument that would conflict with itself by default (e.g.
|
||||||
/// [`ArgAction::Set`][ArgAction::Set], it will now override itself.
|
/// [`ArgAction::Set`], it will now override itself.
|
||||||
///
|
///
|
||||||
/// This is the equivalent to saying the `foo` arg using [`Arg::overrides_with("foo")`] for all
|
/// This is the equivalent to saying the `foo` arg using [`Arg::overrides_with("foo")`] for all
|
||||||
/// defined arguments.
|
/// defined arguments.
|
||||||
|
|
|
@ -514,7 +514,7 @@ impl ArgMatches {
|
||||||
MatchesError::unwrap(id, self.try_contains_id(id))
|
MatchesError::unwrap(id, self.try_contains_id(id))
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Iterate over [`Arg`][crate::Arg] and [`ArgGroup`][crate::ArgGroup] [`Id`][crate::Id]s via [`ArgMatches::ids`].
|
/// Iterate over [`Arg`][crate::Arg] and [`ArgGroup`][crate::ArgGroup] [`Id`]s via [`ArgMatches::ids`].
|
||||||
///
|
///
|
||||||
/// # Examples
|
/// # Examples
|
||||||
///
|
///
|
||||||
|
@ -1325,7 +1325,7 @@ pub(crate) struct SubCommand {
|
||||||
pub(crate) matches: ArgMatches,
|
pub(crate) matches: ArgMatches,
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Iterate over [`Arg`][crate::Arg] and [`ArgGroup`][crate::ArgGroup] [`Id`][crate::Id]s via [`ArgMatches::ids`].
|
/// Iterate over [`Arg`][crate::Arg] and [`ArgGroup`][crate::ArgGroup] [`Id`]s via [`ArgMatches::ids`].
|
||||||
///
|
///
|
||||||
/// # Examples
|
/// # Examples
|
||||||
///
|
///
|
||||||
|
|
|
@ -36,7 +36,7 @@ pub trait Generator {
|
||||||
/// ```
|
/// ```
|
||||||
fn file_name(&self, name: &str) -> String;
|
fn file_name(&self, name: &str) -> String;
|
||||||
|
|
||||||
/// Generates output out of [`clap::Command`](Command).
|
/// Generates output out of [`clap::Command`].
|
||||||
///
|
///
|
||||||
/// # Panics
|
/// # Panics
|
||||||
///
|
///
|
||||||
|
@ -44,7 +44,7 @@ pub trait Generator {
|
||||||
///
|
///
|
||||||
/// # Examples
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// The following example generator displays the [`clap::Command`](Command)
|
/// The following example generator displays the [`clap::Command`]
|
||||||
/// as if it is printed using [`std::println`].
|
/// as if it is printed using [`std::println`].
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
|
|
|
@ -109,7 +109,7 @@ pub fn longs_and_visible_aliases(p: &Command) -> Vec<String> {
|
||||||
.collect()
|
.collect()
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Gets all the flags of a [`clap::Command`](Command).
|
/// Gets all the flags of a [`clap::Command`].
|
||||||
/// Includes `help` and `version` depending on the [`clap::Command`] settings.
|
/// Includes `help` and `version` depending on the [`clap::Command`] settings.
|
||||||
pub fn flags(p: &Command) -> Vec<Arg> {
|
pub fn flags(p: &Command) -> Vec<Arg> {
|
||||||
debug!("flags: name={}", p.get_name());
|
debug!("flags: name={}", p.get_name());
|
||||||
|
|
Loading…
Reference in a new issue