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: Adjust how we approach author #5317

Merged
merged 2 commits into from
Jan 17, 2024
Merged

docs: Adjust how we approach author #5317

merged 2 commits into from
Jan 17, 2024

Conversation

epage
Copy link
Member

@epage epage commented Jan 17, 2024

We've been getting questions like #5316 which shows that the discoverability of how to see that field is less than ideal. In fact, it only is talked about for the sake of version migration and for Command::author. Most derive users won't see that.

Steps

  • Point derive users to help_template, like Command::author does
  • Don't have useless author attributes that raise the question (rather than document it in the tutorial)

command! doesn't mention author, so I left it alone.

@epage epage merged commit ef45f2d into clap-rs:master Jan 17, 2024
21 of 22 checks passed
@epage epage deleted the author branch January 17, 2024 15:06
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.

1 participant