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

Add to Derive Reference an example of what a derive exapnds to #3520

Open
2 tasks done
epage opened this issue Feb 28, 2022 · 0 comments
Open
2 tasks done

Add to Derive Reference an example of what a derive exapnds to #3520

epage opened this issue Feb 28, 2022 · 0 comments
Labels
A-docs Area: documentation, including docs.rs, readme, examples, etc... C-enhancement Category: Raise on the bar on expectations E-easy Call for participation: Experience needed to fix: Easy / not much

Comments

@epage
Copy link
Member

epage commented Feb 28, 2022

Please complete the following tasks

Clap Version

3.1.0

Describe your use case

In the derive reference, we try to explain the principles for how the derive works so people can use any part of the builder documentation as part of the derive but we still frequently get questions on how to use a feature.

Describe the solution you'd like

A more concrete example of the principles will hopefully help.

We shouldn't just run cargo expand but show it as idiomatic.

We should include

  • Command methods
  • Arg methods
  • Subcommands
  • PossibleValue methods

Alternatives, if applicable

No response

Additional Context

No response

@epage epage added C-enhancement Category: Raise on the bar on expectations A-docs Area: documentation, including docs.rs, readme, examples, etc... E-easy Call for participation: Experience needed to fix: Easy / not much labels Feb 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation, including docs.rs, readme, examples, etc... C-enhancement Category: Raise on the bar on expectations E-easy Call for participation: Experience needed to fix: Easy / not much
Projects
None yet
Development

No branches or pull requests

1 participant