Add sections to allow some customisation of help layout #2196
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
I wanted to give this a try, but not sure it adds enough value or is easy enough to use. Opening a draft with proof of concept.
Problem
It isn't convenient to customise the order of sections in the Help.
See #1870
Solution
Create "sections" in
formatHelp
and callvisibleSections
which can be overridden to customise the list. Some possible use cases:Example client code to put options after commands:
ChangeLog