From 659e936a02621f82339b341f505fd694bac63b5a Mon Sep 17 00:00:00 2001 From: Peter Gerber Date: Mon, 13 May 2024 17:47:18 +0000 Subject: [PATCH] docs: Fix documentation for Command::*long_*() long_help() does not propagate the message to help(). Nor do the others. --- clap_builder/src/builder/command.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/clap_builder/src/builder/command.rs b/clap_builder/src/builder/command.rs index 5094a18d..59b2dffc 100644 --- a/clap_builder/src/builder/command.rs +++ b/clap_builder/src/builder/command.rs @@ -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. @@ -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 /// @@ -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 ///