Refactor the man page #451
Open
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
- use definition lists (:) to explain options - remove line breaks that get carried over after being processed by go-md2man - add and explain some missing options (-f, -d, -h, -V) - split dynamic mapping into its own section, go-md2man can't handle multiple paragraphs in definition lists Signed-off-by: Nejc Bertoncelj <[email protected]>
Signed-off-by: Nejc Bertoncelj <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This is a rehaul of fuse-overlayfs.1.md. I've mostly addressed the formatting problems but also tried to improve some of the explanations. Details are explained in commit messages. Tested with go-md2man 2.0.0. Before and after previews are attached below, albeit without any rich formatting.
Man page before
Man page after