New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: Fix demo help #5737

Open

adamchainz wants to merge 1 commit into clap-rs:master from adamchainz:patch-1

adamchainz commented Sep 20, 2024

It gets pulled from the comment here: https://github.com/clap-rs/clap/blob/master/examples/demo.rs#L3


          docs: Fix demo help

6464cf4

It gets pulled from the comment here: https://github.com/clap-rs/clap/blob/master/examples/demo.rs#L3

Member

epage commented Sep 20, 2024

The about attribute is overriding the doc comment.

Because of the role of demo we want to show about but we likely don't want it to show clap's package.documentation.

One option is to remove the doc comment and add the following after the existing about

# #[command(about = "Simple program to greet a person")] // emulating implicit about`

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet