Skip to content

Commit

Permalink
docs(ref): Clean up long help descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
epage committed May 20, 2024
1 parent d408a82 commit 4aefa3c
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions clap_builder/src/builder/command.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1740,7 +1740,8 @@ impl Command {

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

0 comments on commit 4aefa3c

Please sign in to comment.