Implementation of the default help command returns an Err as result

[shard77]

Greetings,

I am currently working with clap-rs for command line argument parsing in a Rust project. During implementation, I've encountered a behavior regarding the default help command that perplexes me. Specifically, when invoking the help command, it appears to result in an Err rather than an Ok within the context of Args::try_parse.

Further investigation through debugging outputs the following:

[src/main.rs:23:5] args_parsed = Err(
    ErrorInner {
        kind: DisplayHelp,

This implementation strategy strikes me as unconventional. Typically, one would expect the invocation of a help command to result in a positive acknowledgment (Ok result), especially considering that the default -h and --help arguments also produce an Ok result. The categorization of DisplayHelp as an error seems counterintuitive to me.

Could someone please provide insight or clarification on this design choice? Is there a specific rationale behind mapping the help command's execution to an Err result? I am keen to understand if there's an aspect I might be overlooking or misunderstanding regarding this design decision, thanks!

[epage]

help / --help needs to short-circuit processing within both clap and the users application. This is done by expressing it as an error.

To help with this, we do offer:

• Error::exit_code
• Error:exit

[shard77]

Makes sense! Thanks for explaining 👍