Add APIs for generating the help screen #142
Merged
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.
Description
This adds two methods for generating the help screen for a command or subcommand.
Detailed Design
The additions includes two methods, one on
ParsableArgumentsand one onParsableCommand. The second method has asubcommandparameter, and is called on the root command to generate the help text for a subcommand:The two new methods:
Documentation Plan
Documentation is included for the new methods, and I've added a section at the end of the guide about customizing help.
Test Plan
I've added tests of these APIs wherever we've previously been testing the help screens.
Source Impact
This is an additive change only.
Checklist