undocumented/hidden options

[andrewchambers]

Occasionally I want to have undocumented/hidden options that do not appear in the --help list, either due to experimental status, or deprecation. I was wondering if this is currently possible, or if this is feature people would be interested in having?

[orhun]

I have the same use case and I think this feature would be good.

[tgross35]

Labeled help wanted in case anyone is interested in picking this up. I think the ideal thing to do here would be to change the signature for Options::opt to:

pub fn opt(
    &mut self,
    short_name: &str,
    long_name: &str,
    desc: &str,
    hint: &str,
    options: OptOptions,
) -> &mut Options

#[non_exhaustive]
pub struct OptOptions {
    has_arg: HasArg,
    occur: Occur,
    hidden: bool,
}

which leaves the door open to more configuration in the future.

This would be a breaking change.