This repository has been archived by the owner on Apr 13, 2024. It is now read-only.
help+printf: Add support for extra help sections, and use them to document printf #66
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
A command can define this to add extra sections to their help output,
which appear after the list of options:
```
helpSections: { 'title': 'text', 'title 2': 'text 2' }
```
This is useful for commands that require detailed explanation (such as
printf and sed) that you want to be grouped with subheadings, and not
get in the way of reading the options.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
I realised I never documented how to use the
printfbuiltin, so here is some documentation. And a new feature all commands can use to add extra documentation sections that don't want to appear before the Options.