Fix the man pages' formatting. #19058
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
I'm thinking about learning myself a little Coq, but there's a glaring rock in the way: The man pages are badly formatted. Can't possibly attempt to learn as long as they stay that way. The main changes are these: Empty lines emit vertical space; replace by stylistic no-ops or actual paragraph separators. Wherever there should be a hyphen-minus in the output, use \- in the input. Tell troff where a sentence ends by following it by a newline. Ellipses look nicer with a little space between the dots; do that. The description in the NAME section shouldn't be capitalized and should be nicely readable. Let the man page titles be what the man pages are about. Don't use font-alternating macros where simple font-changing macros suffice. There's more that I'd change if I were in control of the man pages, but that's less important. If you want more rationale for the things I did do, ask me. I'm happy to talk about troff.
coqbot-app
bot
added
the
needs: full CI
SkySkimmer
approved these changes
May 23, 2024
SkySkimmer
added
kind: documentation
|
@coqbot merge now |
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.
I'm thinking about learning myself a little Coq, but there's a glaring rock in the way: The man pages are badly formatted. Can't possibly attempt to learn as long as they stay that way.
The main changes are these:
Empty lines emit vertical space; replace by stylistic no-ops or actual paragraph separators.
Wherever there should be a hyphen-minus in the output, use - in the input.
Tell troff where a sentence ends by following it by a newline.
Ellipses look nicer with a little space between the dots; do that.
The description in the NAME section shouldn't be capitalized and should be nicely readable.
Let the man page titles be what the man pages are about.
Don't use font-alternating macros where simple font-changing macros suffice.
There's more that I'd change if I were in control of the man pages, but that's less important. If you want more rationale for the things I did do, ask me. I'm happy to talk about troff.