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

docs(tutorial): Smooth over tutorial problems, a little #4985

Merged
merged 3 commits into from Jun 23, 2023

Conversation

epage
Copy link
Member

@epage epage commented Jun 23, 2023

Some problems we've identified

  • People are missing the cargo add -F derive on the main docs page and the footnote about using derive, so specifying cargo add -F derive in the tutorial should help draw attention to it
  • People are confused by the inferred behavior from args, so prefer linking to the derive reference on the topic so people discover it sooner
  • People are confused by magic vs raw attributes
    • Call this out in the "next steps" from the tutorial
    • Link out to the builder API more to help build the connection in people's minds

This is not a definitive fix but incremental improvement

This is particularly to help call attention to builder methods as
attributes (clap-rs#4090).
This is another step for trying to improve the understanding that the
derive and builder APIs are linked (clap-rs#4090).

This also adds links to make it easier to discover more details on how
we infer behavior from a field's type.
@epage epage merged commit f5d64d7 into clap-rs:master Jun 23, 2023
21 checks passed
@epage epage deleted the docs branch June 23, 2023 21:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant