docs(derive): Flatten isn't just for update

clap-rs · Aug 16, 2024 · df165a2 · df165a2
1 parent 5488bcf
commit df165a2
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/clap_builder/src/derive.rs b/clap_builder/src/derive.rs
@@ -219,6 +219,8 @@ pub trait Args: FromArgMatches + Sized {
     /// Append to [`Command`] so it can instantiate `Self` via
     /// [`FromArgMatches::from_arg_matches_mut`]
     ///
+    /// This is used to implement `#[command(flatten)]`
+    ///
     /// See also [`CommandFactory::command`].
     fn augment_args(cmd: Command) -> Command;
     /// Append to [`Command`] so it can instantiate `self` via
@@ -244,6 +246,8 @@ pub trait Subcommand: FromArgMatches + Sized {
     /// Append to [`Command`] so it can instantiate `Self` via
     /// [`FromArgMatches::from_arg_matches_mut`]
     ///
+    /// This is used to implement `#[command(flatten)]`
+    ///
     /// See also [`CommandFactory::command`].
     fn augment_subcommands(cmd: Command) -> Command;
     /// Append to [`Command`] so it can instantiate `self` via