doc: improve formatting of STYLE_GUIDE.md #13135
Closed
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
* Wrap text at 80 characters. * Use periods consistently.
gibfahn
approved these changes
May 20, 2017
refack
approved these changes
May 21, 2017
Trott
approved these changes
May 21, 2017
doc/STYLE_GUIDE.md
Outdated
| * Pronouns are acceptable in more colloquial documentation, like guides. | ||
| * Use **gender-neutral pronouns** and **mass nouns**. Non-comprehensive | ||
| examples: | ||
| * **OK**: "they", "their", "them", "folks", "people", "developers", "cats" | ||
| * **OK**: "they", "their", "them", "folks", "people", "developers", "cats". |
There was a problem hiding this comment.
Nit: This line and the following line probably shouldn't end with periods because they are not sentences. They are just lists. I'm OK with using a period anyway for consistency or simplicity, but I do have a slight preference for leaving the period off in this case.
There was a problem hiding this comment.
Yeah, I wasn't sure about these. They look a bit more natural without periods.
doc/STYLE_GUIDE.md
Outdated
| * References to constructor functions should use PascalCase | ||
| * References to constructor instances should be camelCased | ||
| * References to methods should be used with parentheses: `socket.end()` instead of `socket.end` | ||
| * When using underscores, asterisks and backticks please use proper escaping |
There was a problem hiding this comment.
Nit: While we're in here, can you add a comma after asterisks and backticks. (Kind of funny that this very guide recommends using a serial comma and then misses one right here!)
doc/STYLE_GUIDE.md
Outdated
| * When using underscores, asterisks and backticks please use proper escaping | ||
| (**\\\_**, **\\\*** and **\\\`** instead of **\_**, **\*** and **\`**). | ||
| * References to constructor functions should use PascalCase. | ||
| * References to constructor instances should be camelCased. |
There was a problem hiding this comment.
Nit: be camelCased -> use camelCase
That will be consistent with the previous line and avoid awkwardly using camelCase as a verb.
doc/STYLE_GUIDE.md
Outdated
| (**\\\_**, **\\\*** and **\\\`** instead of **\_**, **\*** and **\`**). | ||
| * References to constructor functions should use PascalCase. | ||
| * References to constructor instances should be camelCased. | ||
| * References to methods should be used with parentheses: `socket.end()` instead |
There was a problem hiding this comment.
Nit: While we're in here, add for example, after the colon.
lpinca
approved these changes
May 21, 2017
jasnell
approved these changes
May 22, 2017
|
LGTM Landed in eebc262 |
addaleax
pushed a commit
that referenced
this pull request
May 23, 2017
* Wrap text at 80 characters. * Use periods consistently. PR-URL: #13135 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
jasnell
pushed a commit
that referenced
this pull request
May 24, 2017
* Wrap text at 80 characters. * Use periods consistently. PR-URL: #13135 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
jasnell
pushed a commit
that referenced
this pull request
May 28, 2017
* Wrap text at 80 characters. * Use periods consistently. PR-URL: #13135 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
3 tasks
MylesBorins
pushed a commit
that referenced
this pull request
Jul 17, 2017
* Wrap text at 80 characters. * Use periods consistently. PR-URL: #13135 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
Merged
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.
Checklist
Affected core subsystem(s)
doc