Enforce the "one sentence per line" rule in docs #4377
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
crisluengo
reviewed
Jan 16, 2019
pchaigno
reviewed
Jan 21, 2019
|
This pull request has been automatically marked as stale because it has not had recent activity, and will be closed if no further activity occurs. If this pull request was overlooked, forgotten, or should remain open for any other reason, please reply here to call attention to it and remove the stale status. Thank you for your contributions. |
|
@pchaigno Anything left to do here? |
pchaigno
approved these changes
Mar 26, 2019
lildude
approved these changes
Apr 4, 2019
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
To make diffs easier to review, I've refactored
README.mdandCONTRIBUTING.mdto limit lines to no more than one sentence.In addition, I fixed a few typos, made more optimal use of reference links, and made shell-commands tagged code-blocks to enable highlighting.
Refs: #4271 (comment)
/cc @pchaigno because this will probably break his pull-request