Subcommand hijacks parent's about

[epage]

Issue by CodeSandwich
Thursday May 14, 2020 at 09:35 GMT
Originally opened as TeXitoi/structopt#391

---

I have a simple program:

use structopt::StructOpt;

/// The main thing
#[derive(StructOpt)]
struct Main {
    #[structopt(subcommand)]
    subcommand: Subcommand,
}

/// The subcommand
#[derive(StructOpt)]
enum Subcommand {
    A{}
}

fn main() {
    Main::from_args();
}

When I run it with cargo run -- --help, I get the following output:

poligon 0.1.0
The subcommand

USAGE:
    poligon <SUBCOMMAND>

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

SUBCOMMANDS:
    a       
    help    Prints this message or the help of the given subcommand(s)

The app description should be The main thing, not The subcommand!

[epage]

Comment by TeXitoi
Friday May 15, 2020 at 06:55 GMT

---

Thanks for the clear report.

[epage]

Comment by pizzamig
Monday Jul 20, 2020 at 21:41 GMT

---

This also prevents flattening of struct with their own rustdoc:

use structopt::StructOpt;

#[derive(Debug, StructOpt)]
#[structopt(name = "structopt-bug", about = "Show a bug in Structopt")]
struct Opt {
    #[structopt(flatten)]
    v: Verbose,
}

/// Re-usable Verbose flag
#[derive(Debug, StructOpt)]
struct Verbose {
    /// Enable the verbosity messages
    #[structopt(short)]
    verbose: bool,
}
fn main() {
    let opt = Opt::from_args();
    println!("{:?}", opt);
}

The cargo run -- -h shows:

structopt-bug 0.1.0
Re-usable Verbose flag

USAGE:
    structopt-bug [FLAGS]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information
    -v               Enable the verbosity messages

[epage]

Is this a dup of #3127 ? Is it already fixed?

[pksunkara]

Yeah, that's what I was wondering. Didn't you already fix this and #3127?

[epage]

Confirmed, this is fixed

use clap::StructOpt;

/// The main thing
#[derive(StructOpt)]
struct Main {
    #[structopt(subcommand)]
    subcommand: Subcommand,
}

/// The subcommand
#[derive(StructOpt)]
enum Subcommand {
    A {},
}

fn main() {
    Main::from_args();
}

test-clap 

The main thing

USAGE:
    test-clap <SUBCOMMAND>

OPTIONS:
    -h, --help    Print help information

SUBCOMMANDS:
    a       
    help    Print this message or the help of the given subcommand(s)