feat: add support for examples #13
Merged
Conversation
This file contains hidden or 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
Owner
|
Thank you, @jon4hz! |
Contributor
Author
|
My pleasure! Will add a PR for mango-cobra and mango-coral when the next release is out :) |
This was referenced Oct 15, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Some libraries like cobra allow you to set examples for commands.
This PR extends the
mango.Commandwith an example which will be added to the man page automatically.The placement of the examples is roughly according to https://linux.die.net/man/7/man-pages
An example implementation for a mango adapter can be found here: muesli/mango-cobra@main...jon4hz:mango-cobra:main