Skip to content

Commit

Permalink
Merge pull request #3693 from epage/template
Browse files Browse the repository at this point in the history
fix(help): Use display name instead of bin name (unstable-v4)
  • Loading branch information
epage authored May 5, 2022
2 parents 41a8a5b + e4c096e commit 2375a8e
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
16 changes: 16 additions & 0 deletions src/output/help.rs
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,15 @@ pub(crate) struct Help<'help, 'cmd, 'writer> {

// Public Functions
impl<'help, 'cmd, 'writer> Help<'help, 'cmd, 'writer> {
#[cfg(feature = "unstable-v4")]
const DEFAULT_TEMPLATE: &'static str = "\
{before-help}{name} {version}\n\
{author-with-newline}{about-with-newline}\n\
{usage-heading}\n {usage}\n\
\n\
{all-args}{after-help}\
";
#[cfg(not(feature = "unstable-v4"))]
const DEFAULT_TEMPLATE: &'static str = "\
{before-help}{bin} {version}\n\
{author-with-newline}{about-with-newline}\n\
Expand All @@ -40,6 +49,13 @@ impl<'help, 'cmd, 'writer> Help<'help, 'cmd, 'writer> {
{all-args}{after-help}\
";

#[cfg(feature = "unstable-v4")]
const DEFAULT_NO_ARGS_TEMPLATE: &'static str = "\
{before-help}{name} {version}\n\
{author-with-newline}{about-with-newline}\n\
{usage-heading}\n {usage}{after-help}\
";
#[cfg(not(feature = "unstable-v4"))]
const DEFAULT_NO_ARGS_TEMPLATE: &'static str = "\
{before-help}{bin} {version}\n\
{author-with-newline}{about-with-newline}\n\
Expand Down
4 changes: 2 additions & 2 deletions tests/builder/help.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2615,7 +2615,7 @@ fn override_help_flag_using_short() {
fn subcommand_help_doesnt_have_useless_help_flag() {
// The main care-about is that the docs and behavior match. Since the `help` subcommand
// currently ignores the `--help` flag, the output shouldn't have it.
let cmd = Command::new("test_app").subcommand(Command::new("test").about("Subcommand"));
let cmd = Command::new("example").subcommand(Command::new("test").about("Subcommand"));

utils::assert_output(
cmd,
Expand Down Expand Up @@ -2655,7 +2655,7 @@ fn disable_help_flag_affects_help_subcommand() {

#[test]
fn dont_propagate_version_to_help_subcommand() {
let cmd = clap::Command::new("test")
let cmd = clap::Command::new("example")
.version("1.0")
.propagate_version(true)
.subcommand(clap::Command::new("subcommand"));
Expand Down

0 comments on commit 2375a8e

Please sign in to comment.