uudoc: improve man page formatting for examples#11031
Open
piperswe wants to merge 1 commit intouutils:mainfrom
Open
uudoc: improve man page formatting for examples#11031piperswe wants to merge 1 commit intouutils:mainfrom
piperswe wants to merge 1 commit intouutils:mainfrom
Conversation
Currently we're interpolating a strange mixture of Markdown and plain text into man pages for the "Examples" section. This commit sets up a proper "EXAMPLES FROM TLDR.SH" section, and uses roff formatting to properly format the example code. I was sure to leave space for a proper "EXAMPLES" section in the future, should this project want to put together its own collection of examples to avoid reliance on tldr.sh.
Contributor
|
would it be possible to have a test to make sure we don't regress? thanks |
|
GNU testsuite comparison: |
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
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.
Currently we're interpolating a strange mixture of Markdown and plain text into man pages for the "Examples" section. This commit sets up a proper "EXAMPLES FROM TLDR.SH" section, and uses roff formatting to properly format the example code.
I was sure to leave space for a proper "EXAMPLES" section in the future, should this project want to put together its own collection of examples to avoid reliance on tldr.sh.