Skip to content
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.

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

Derive reference doesn't mention group #3754

Closed
2 tasks done
manfredlotz opened this issue May 25, 2022 · 3 comments
Closed
2 tasks done

Derive reference doesn't mention group #3754

manfredlotz opened this issue May 25, 2022 · 3 comments
Labels
C-enhancement Category: Raise on the bar on expectations

Comments

@manfredlotz
Copy link

Please complete the following tasks

Clap Version

3.1.18

Describe your use case

The derive tutorial does mention group but the derive reference doesn't. I think it should be mentioned there as well.

Describe the solution you'd like

Mention group in the clap derive reference.

Alternatives, if applicable

No response

Additional Context

No response

@manfredlotz manfredlotz added the C-enhancement Category: Raise on the bar on expectations label May 25, 2022
@epage
Copy link
Member

epage commented May 25, 2022

We have intentionally decided to not enumerate every possible attribute in the derive documentation due to the maintenance burden of that. Instead the derive reference explains how raw attributes work and reminds people when looking at Command attributes that raw attributes exist, linking to the relevant documentation for using those raw attributes.

@epage epage closed this as completed May 25, 2022
@manfredlotz
Copy link
Author

Ok, I only came up with this because somebody asked about it here https://users.rust-lang.org/t/clap-derive-required-flags-or-options-that-are-exclusive-to-each-other/75998/4 .

@epage
Copy link
Member

epage commented Aug 18, 2022

I've created #4090 to further discuss the documentation of raw attributes as this keeps coming up

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Category: Raise on the bar on expectations
Projects
None yet
Development

No branches or pull requests

2 participants