Add optional summary for short form of subcommand description. #1726
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
shadowspawn
added
the
pending release
shadowspawn
removed
the
pending release
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.
Pull Request
Problem
The same description is used in the compact listing of subcommands, as in the full help for a subcommand. In the former case a one-liner makes sense, but may want multiple lines in the full command description.
Related: #898 #1291 #1469 #1506
A work-around is to add a long description after the built-in help in
.addHelpText('after', longDescription).Solution
Add optional
.summary().For backwards compatibility, the description is used for the subcommand listing if the summary is missing. So by default there is no change in existing programs.
ChangeLog
.summary()for a short summary to use instead of description when listing subcommands in help