Minor documentation fixes #3402
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 predict this will save horizontal scrolling by at least 36%. *Note*: 93% of all statistics are entirely made-up on the spot.
I noticed there was a few code/shell elements that may benefit from being backticked. It should help one scan this guide and pick out some of the most useful reference points.
|
I don't know if I can speak for everyone else, but I personally don't like editing markdown that is 'hard-wrapped'. Most text editors will soft-wrap it for you, and it saves you the trouble of having to add and remove newlines every time you change a word or sentence. |
|
@jemc fair point, I guess it's a matter of opinion. |
|
@jemc soft wrapping is a tool for the devil, I've yet to find a single editor that can do it well. Also not everybody views Markdown on either Github or in an editor capable of soft wrapping lines. For example, I regularly read text files using Outside of that the PR looks fine to me. |
yorickpeterse
pushed a commit
that referenced
this pull request
May 16, 2015
Minor documentation fixes
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 was scanning the
CONTRIBUTINGguide and noticed a couple minor issues.馃槏