Link to the clap method list in the documentation #511
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…can be used This may help hammer home the point for new users who don't know the clap API and might not realize this is a lot of functionality.
|
Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When I first started using structopt, I had also not used clap. It wasn't clear to me that clap contained a ton of functionality, and that the clap docs were the likely place to look if I needed to change some default behavior. The structopt docs are perfectly clear as is, but I think adding links will drive home the point that there are a ton of extra methods available (listed in the clap documentation).
Additionally, linking to the list of clap methods may be convenient for users browsing the structopt documentation who realize something they need doesn't exist in structopt.