Skip to content

Commit

Permalink
docs: Fix documentation for Command::*long_*()
Browse files Browse the repository at this point in the history
long_help() does not propagate the message to help(). Nor do the
others.
  • Loading branch information
pgerber committed May 20, 2024
1 parent 7d3a380 commit 659e936
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions clap_builder/src/builder/command.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1740,7 +1740,7 @@ impl Command {

/// Sets the program's description for the long help (`--help`).
///
/// If [`Command::about`] is not specified, this message will be displayed for `-h`.
/// Use [`Command::about`] to display the same message for `-h` too.
///
/// **NOTE:** Only [`Command::about`] (short format) is used in completion
/// script generation in order to be concise.
Expand Down Expand Up @@ -1792,7 +1792,7 @@ impl Command {
/// This is often used to describe how to use the arguments, caveats to be noted, or license
/// and contact information.
///
/// If [`Command::after_help`] is not specified, this message will be displayed for `-h`.
/// Use [`Command::after_help`] to display the same message for `-h` too.
///
/// # Examples
///
Expand Down Expand Up @@ -1835,7 +1835,7 @@ impl Command {
///
/// This is often used for header, copyright, or license information.
///
/// If [`Command::before_help`] is not specified, this message will be displayed for `-h`.
/// Use [`Command::before_help`] to display the same message for `-h` too.
///
/// # Examples
///
Expand Down

0 comments on commit 659e936

Please sign in to comment.