Use .EX/.EE to typeset code blocks #95
Merged
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
There is no need to indent section contents. More to say, this results in wrong indentation in the resulting man page. While at it, capitalize section names. Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
1. Use some standard formatting rules, such as - literals are bold; - variables are italic; - file names are italic (even when literal); - use ``` for code blocks. 2. Add an example with shell redirection. Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
A pair of man macros named .EX and .EE are specifically created for things like code examples. This is ideally suited to typeset markdown code wrapped into ``` pairs. Add a simple test case. Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
cpuguy83
approved these changes
Apr 27, 2023
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.
No description provided.