Use uniform formatting for SEE ALSO sections #2732
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
|
Improved wording of the commit message |
|
Hmm, on a random sampling (strtok, ls, systemd-inhibit, ssh, bash, auditd, getopt, grep, xhost, vim), bold was by far the most common style. That's what "man man" also uses, which one could think of as the "canonical source of truth" I guess. Italics (or underline as it renders for me) is typically used for paths. |
While there is no generally agreed standard for formatting SEE ALSO section of man pages we should at least use only one style. Comma separated lists are commonly used when referring to other man pages. Both *italic* and **bold** are used but the later seems to be more popular - so let's stick to that. Thanks to Frank Dana <https://github.com/ferdnyc> for pointing this out. Resolves: rpm-software-management#2731
|
I don't have a strong opinion. Guess it depends on what pages you sample. I just switched to bold. |
|
I don't have a strong opinion either, this was just a statistical observation 😄 |
And therefore technically correct. ("The best kind of correct!") |
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.
While there is no generally agreed standard for this we should at least use only one. Comma separated lists are commonly used. Let's just pick italic for man pages.
Thanks to Frank Dana https://github.com/ferdnyc for pointing this out.
Resolves: #2731