This repository has been archived by the owner on Apr 14, 2021. It is now read-only.
Fix incorrect sectioning in gemfile
man page
#7265
Merged
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.
What was the end-user problem that led to this PR?
The problem was that Gemfile's man page has incorrect syntax in the section where examples for
:ref
,:tag
and:branch
are given.What was your diagnosis of the problem?
My diagnosis was that the section was incorrect since the examples were listed as a separate section. Also, the syntax seems incorrect, since building the docs with ronn-ng (something I've been experimenting with lately) gives the following error:
What is your fix for the problem, implemented in this PR?
My fix is to correct the syntax. The comparison of the rendered man page is:
bundle help gemfile
(before)bundle help gemfile
(after)Why did you choose this fix out of the possible options?
I chose this fix because it seems like the right thing to do.