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

Merge pull request #5200 from epage/group

Browse source 
docs(ref): Be clear about implicit ArgGroup behavior
This commit is contained in:
Ed Page 2023-11-07 14:12:11 -06:00 committed by GitHub
commit b055d3d4c0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 12 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
clap_builder/src/builder/arg.rs
View file

@ -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)`].
/// ///

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

@ -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.

4
clap_builder/src/parser/matches/arg_matches.rs
View file

@ -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
/// ///

4
clap_complete/src/generator/mod.rs
View file

@ -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`].
/// ///
/// ``` /// ```

2
clap_complete/src/generator/utils.rs
View file

@ -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());

4
src/_derive/mod.rs
View file

@ -203,6 +203,10 @@
//! - `skip [= <expr>]`: Ignore this field, filling in with `<expr>` //! - `skip [= <expr>]`: Ignore this field, filling in with `<expr>`
//! - Without `<expr>`: fills the field with `Default::default()` //! - Without `<expr>`: fills the field with `Default::default()`
//! //!
//! Note:
//! - For `struct`s, [`multiple = true`][crate::ArgGroup::multiple] is implied
//! - `enum` support is tracked at [#2621](https://github.com/clap-rs/clap/issues/2621)
//!
//! ### Arg Attributes //! ### Arg Attributes
//! //!
//! These correspond to a [`Arg`][crate::Arg]. //! These correspond to a [`Arg`][crate::Arg].