FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: improve style guide text by Trott · Pull Request #19269 · nodejs/node · GitHub

/ node Public

doc: improve style guide text - #19269

Closed
Trott wants to merge 1 commit into
nodejs:masterfrom
Trott:style-the-style-guide
ConversationCommits (1)ChecksFiles changed
Closed

doc: improve style guide text#19269
Trott wants to merge 1 commit into
nodejs:masterfrom
Trott:style-the-style-guide

Conversation

Trott commented Mar 9, 2018

Copy link
Copy Markdown
Member
  • Specify that personal pronouns are OK in colloquial documentation
    rather than just pronouns. Pronouns are OK in all documentation. (For
    example, "it" is a pronoun and is acceptable in all types of
    documentation.) Specify "personal pronouns" for clarity.
  • more colloquial -> colloquial
  • like -> such as
  • Remove "mass nouns" as no mass nouns are given as examples. Plural
    nouns seems to be what was meant, so use that instead.
  • Repeat "gender-neutral" to make it clear that it refers to both terms
    and not merely the first term it appears before.
  • Remove "non-comprehensive examples". Examples are, by definition,
    non-comprehensive. No need to announce that the examples are examples.
    It is obvious.
Checklist

doc: improve style guide text
1be8b84 
* Specify that personal pronouns are OK in colloquial documentation
  rather than just pronouns. Pronouns are OK in all documentation. (For
  example, "it" is a pronoun and is acceptable in all types of
  documentation.) Specify "personal pronouns" for clarity.
* more colloquial -> colloquial
* like -> such as
* Remove "mass nouns" as no mass nouns are given as examples. Plural
  nouns seems to be what was meant, so use that instead.
* Repeat "gender-neutral" to make it clear that it refers to both terms
  and not merely the first term it appears before.
* Remove "non-comprehensive examples". Examples are, by definition,
  non-comprehensive. No need to announce that the examples are examples.
  It is obvious.
nodejs-github-bot added the doc Issues and PRs related to the documentations. label Mar 9, 2018

Trott commented Mar 9, 2018

Copy link
Copy Markdown
Member Author

CI: https://ci.nodejs.org/job/node-test-pull-request-lite/247/

Trott added the author ready PRs that have at least one approval, no outstanding review comments, and a CI started. label Mar 10, 2018
Trott added a commit to Trott/io.js that referenced this pull request Mar 13, 2018
doc: improve style guide text
8ed0f34 
* Specify that personal pronouns are OK in colloquial documentation
  rather than just pronouns. Pronouns are OK in all documentation. (For
  example, "it" is a pronoun and is acceptable in all types of
  documentation.) Specify "personal pronouns" for clarity.
* more colloquial -> colloquial
* like -> such as
* Remove "mass nouns" as no mass nouns are given as examples. Plural
  nouns seems to be what was meant, so use that instead.
* Repeat "gender-neutral" to make it clear that it refers to both terms
  and not merely the first term it appears before.
* Remove "non-comprehensive examples". Examples are, by definition,
  non-comprehensive. No need to announce that the examples are examples.
  It is obvious.

PR-URL: nodejs#19269
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>

Trott commented Mar 13, 2018

Copy link
Copy Markdown
Member Author

Landed in 8ed0f34

Trott closed this Mar 13, 2018
targos pushed a commit that referenced this pull request Mar 17, 2018
doc: improve style guide text
4dab770 
* Specify that personal pronouns are OK in colloquial documentation
  rather than just pronouns. Pronouns are OK in all documentation. (For
  example, "it" is a pronoun and is acceptable in all types of
  documentation.) Specify "personal pronouns" for clarity.
* more colloquial -> colloquial
* like -> such as
* Remove "mass nouns" as no mass nouns are given as examples. Plural
  nouns seems to be what was meant, so use that instead.
* Repeat "gender-neutral" to make it clear that it refers to both terms
  and not merely the first term it appears before.
* Remove "non-comprehensive examples". Examples are, by definition,
  non-comprehensive. No need to announce that the examples are examples.
  It is obvious.

PR-URL: #19269
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
targos mentioned this pull request Mar 18, 2018
Merged
MylesBorins pushed a commit that referenced this pull request Mar 20, 2018
doc: improve style guide text
e247f19 
* Specify that personal pronouns are OK in colloquial documentation
  rather than just pronouns. Pronouns are OK in all documentation. (For
  example, "it" is a pronoun and is acceptable in all types of
  documentation.) Specify "personal pronouns" for clarity.
* more colloquial -> colloquial
* like -> such as
* Remove "mass nouns" as no mass nouns are given as examples. Plural
  nouns seems to be what was meant, so use that instead.
* Repeat "gender-neutral" to make it clear that it refers to both terms
  and not merely the first term it appears before.
* Remove "non-comprehensive examples". Examples are, by definition,
  non-comprehensive. No need to announce that the examples are examples.
  It is obvious.

PR-URL: #19269
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
MayaLekova pushed a commit to MayaLekova/node that referenced this pull request May 8, 2018
doc: improve style guide text
848434c 
* Specify that personal pronouns are OK in colloquial documentation
  rather than just pronouns. Pronouns are OK in all documentation. (For
  example, "it" is a pronoun and is acceptable in all types of
  documentation.) Specify "personal pronouns" for clarity.
* more colloquial -> colloquial
* like -> such as
* Remove "mass nouns" as no mass nouns are given as examples. Plural
  nouns seems to be what was meant, so use that instead.
* Repeat "gender-neutral" to make it clear that it refers to both terms
  and not merely the first term it appears before.
* Remove "non-comprehensive examples". Examples are, by definition,
  non-comprehensive. No need to announce that the examples are examples.
  It is obvious.

PR-URL: nodejs#19269
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
BethGriggs pushed a commit that referenced this pull request Oct 16, 2018
doc: improve style guide text
459690a 
* Specify that personal pronouns are OK in colloquial documentation
  rather than just pronouns. Pronouns are OK in all documentation. (For
  example, "it" is a pronoun and is acceptable in all types of
  documentation.) Specify "personal pronouns" for clarity.
* more colloquial -> colloquial
* like -> such as
* Remove "mass nouns" as no mass nouns are given as examples. Plural
  nouns seems to be what was meant, so use that instead.
* Repeat "gender-neutral" to make it clear that it refers to both terms
  and not merely the first term it appears before.
* Remove "non-comprehensive examples". Examples are, by definition,
  non-comprehensive. No need to announce that the examples are examples.
  It is obvious.

PR-URL: #19269
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
BethGriggs mentioned this pull request Oct 30, 2018
Merged
beevelop mentioned this pull request Nov 20, 2018
Closed
Trott deleted the style-the-style-guide branch January 13, 2022 22:48
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

lpinca lpinca approved these changes

Assignees

No one assigned

Labels

author ready PRs that have at least one approval, no outstanding review comments, and a CI started. doc Issues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

Back | FazBrowse Home | New Git URL