Update manpage formatting#9136
Merged
MikeMcQuaid merged 5 commits intoHomebrew:masterfrom Nov 16, 2020
Merged
Conversation
EricFromCanada
force-pushed
the
man-page-formatting
branch
2 times, most recently
from
4857d98 to
1ece75f
Compare
Modify parser.rb to add a colon between each term and the line break, which `ronn` converts into a definition list. The <br> that follows ensures each term description is on a new line in the manpage output, and also replaces the double trailing space for generating the hard return that follows each term in the HTML output. Also modify man.rb to print environment variables with list markup matching the cask commands, and then drop trailing colons from both lists of terms (cask commands, env vars) and non-list terms (analytics, bundle, services; a <br> is added here because it would prevent the term description from being indented in the manpage output). https://docs.brew.sh/Manpage#cask-command-options-cask
EricFromCanada
force-pushed
the
man-page-formatting
branch
from
1ece75f to
2bbceaa
Compare
EricFromCanada
force-pushed
the
man-page-formatting
branch
from
2bbceaa to
72bc057
Compare
Member
|
Thanks @EricFromCanada! |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
3 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.
brew stylewith your changes locally?brew testswith your changes locally?brew manlocally and committed any changes?Various improvements to the text and formatting of the
brewmanpage and Markdown output; most notably better handling of lists under theanalytics,cask,bundle,services, Global Cask Options and Environment sections.Depends on Homebrew/homebrew-bundle#813 and Homebrew/homebrew-test-bot#519.