Skip to content

Commit 4aefa3c

Browse files
committed
docs(ref): Clean up long help descriptions
1 parent d408a82 commit 4aefa3c

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

clap_builder/src/builder/command.rs

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1740,7 +1740,8 @@ impl Command {
17401740

17411741
/// Sets the program's description for the long help (`--help`).
17421742
///
1743-
/// Use [`Command::about`] to display the same message for `-h` too.
1743+
/// If not set, [`Command::about`] will be used for long help in addition to short help
1744+
/// (`-h`).
17441745
///
17451746
/// **NOTE:** Only [`Command::about`] (short format) is used in completion
17461747
/// script generation in order to be concise.
@@ -1792,7 +1793,8 @@ impl Command {
17921793
/// This is often used to describe how to use the arguments, caveats to be noted, or license
17931794
/// and contact information.
17941795
///
1795-
/// Use [`Command::after_help`] to display the same message for `-h` too.
1796+
/// If not set, [`Command::after_help`] will be used for long help in addition to short help
1797+
/// (`-h`).
17961798
///
17971799
/// # Examples
17981800
///
@@ -1835,7 +1837,8 @@ impl Command {
18351837
///
18361838
/// This is often used for header, copyright, or license information.
18371839
///
1838-
/// Use [`Command::before_help`] to display the same message for `-h` too.
1840+
/// If not set, [`Command::before_help`] will be used for long help in addition to short help
1841+
/// (`-h`).
18391842
///
18401843
/// # Examples
18411844
///

0 commit comments

Comments
 (0)