[Documentation] Edit for clarity and style #1534
Merged
Conversation
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
Around line 143, gave "constants" its own bullet point. Although it is a form of variable or field, it also forms a separate style element with a different guideline. It's also easier to find when skimming when separated - for new contributors who need to learn the style, and veteran contributors who are just double checking.
Edited for consistent period and parentheses usage throughout: - Removed periods at the end of each element in a list of nouns. - Placed periods outside parenthetical statements that aren't complete sentences themselves. - Placed periods at the end of sentences without punctuation.
jdsandifer
changed the title
|
Thanks for these changes as well, that does read better. I also realize now that I have for many years had wrong ideas about the correct ordering of terminal punctuation and parentheses (which will take some getting used to). Reviewer Checklist
|
|
That kind of thing has definitely happened to me before. And I'm always looking up grammar rules because I usually can't remember all the details and exceptions. |
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.
Around line 143, gave "constants" its own bullet point. Although it is a form of variable or field, it does form a separate style element with a different guideline. It's also easier to find when skimming this way.
Author Checklist:
Changes address original issue? N/A
Unit tests included and/or updated with changes? N/A
Command line build passes? N/A
Changes have been smoke-tested? N/A