Skip to content

Serial comma#17384

Closed
Trott wants to merge 2 commits intonodejs:masterfrom
Trott:serial-comma
Closed

Serial comma#17384
Trott wants to merge 2 commits intonodejs:masterfrom
Trott:serial-comma

Conversation

@Trott
Copy link
Member

@Trott Trott commented Nov 29, 2017

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

Trott added 2 commits November 28, 2017 21:37
@Trott
doc: be concise about serial commas
d61ab57 
There is nothing controversial about serial commas and there is no need
to hedge bets on it. Simply instruct people to use serial commas.
@Trott
doc: add missing serial commas
a95ce6b
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Nov 29, 2017
MylesBorins
MylesBorins approved these changes Nov 29, 2017
View reviewed changes
Copy link
Contributor

@MylesBorins MylesBorins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
Don't think this needs to wait 48 hours

@MylesBorins MylesBorins added the fast-track PRs that do not need to wait for 48 hours to land. label Nov 29, 2017
gibfahn
gibfahn approved these changes Nov 29, 2017
View reviewed changes
doc/STYLE_GUIDE.md
[Em dashes]: https://en.wikipedia.org/wiki/Dash#Em_dash
[Javascript type]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Grammar_and_types#Data_structures_and_types
[Oxford comma]: https://en.wikipedia.org/wiki/Serial_comma
[serial commas]: https://en.wikipedia.org/wiki/Serial_comma
Copy link
Member

@gibfahn gibfahn Nov 29, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pretty outraged about this change 😉 .

@gibfahn
Copy link
Member

gibfahn commented Nov 29, 2017

Considered a patriotic -1 on behalf of the Oxford comma, but decided against it.

There is nothing controversial about serial commas

This is a bold statement, I'm sure there are people who are fanatically against them.

I think it makes things clearer though, so +1.

Chance of a lint rule for it?

maclover7
maclover7 approved these changes Nov 29, 2017
View reviewed changes
Copy link
Contributor

@maclover7 maclover7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

mhdawson
mhdawson approved these changes Nov 29, 2017
View reviewed changes
Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

richardlau
richardlau approved these changes Nov 29, 2017
View reviewed changes
Copy link
Member

@richardlau richardlau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FYI nodejs/docs@a7e0208#diff-4076ed6a9f68805586fe892fab2c17ceR125 introduced the sentence about being controversial.

FWIW I personally prefer not to use serial commas, but this PR isn't changing the guideline so approving based on implementing consistency with the recommended style.

@Trott
Copy link
Member Author

Trott commented Dec 1, 2017 •
edited
Loading

Chance of a lint rule for it?

Unfortunately, not a reliable one. Even robust grammar-checking software has trouble reliably flagging missing serial commas. In some situations, it's impossible to know if a comma is or isn't needed unless you know the meaning of the sentence. Consider, for example, "It was Gibson, a Node.js contributor and an all-around decent human." Without understanding the intended meaning of the sentence, a checker wouldn't know whether contributor needs a comma after it or not.

@Trott
Copy link
Member Author

Trott commented Dec 1, 2017

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

Trott added a commit to Trott/io.js that referenced this pull request Dec 1, 2017
@Trott
doc: be concise about serial commas
d2b2baf 
There is no need to hedge bets on the serial comma. Simply instruct
people to use it.

PR-URL: nodejs#17384
Reviewed-By: Timothy Gu <[email protected]>
Reviewed-By: Alexey Orlenko <[email protected]>
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Myles Borins <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Daniel Bevenius <[email protected]>
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Jon Moss <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
Trott added a commit to Trott/io.js that referenced this pull request Dec 1, 2017
@Trott
doc: add missing serial commas
ff9a6bc 
PR-URL: nodejs#17384
Reviewed-By: Timothy Gu <[email protected]>
Reviewed-By: Alexey Orlenko <[email protected]>
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Myles Borins <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Daniel Bevenius <[email protected]>
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Jon Moss <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
@Trott
Copy link
Member Author

Trott commented Dec 1, 2017

Landed in d2b2baf and ff9a6bc.

@Trott Trott closed this Dec 1, 2017
MylesBorins pushed a commit that referenced this pull request Dec 12, 2017
@Trott @MylesBorins
doc: be concise about serial commas
86c9b43 
There is no need to hedge bets on the serial comma. Simply instruct
people to use it.

PR-URL: #17384
Reviewed-By: Timothy Gu <[email protected]>
Reviewed-By: Alexey Orlenko <[email protected]>
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Myles Borins <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Daniel Bevenius <[email protected]>
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Jon Moss <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
MylesBorins pushed a commit that referenced this pull request Dec 12, 2017
@Trott @MylesBorins
doc: add missing serial commas
72a08db 
PR-URL: #17384
Reviewed-By: Timothy Gu <[email protected]>
Reviewed-By: Alexey Orlenko <[email protected]>
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Myles Borins <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Daniel Bevenius <[email protected]>
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Jon Moss <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
MylesBorins pushed a commit that referenced this pull request Dec 12, 2017
@Trott @MylesBorins
doc: be concise about serial commas
9df52dd 
There is no need to hedge bets on the serial comma. Simply instruct
people to use it.

PR-URL: #17384
Reviewed-By: Timothy Gu <[email protected]>
Reviewed-By: Alexey Orlenko <[email protected]>
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Myles Borins <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Daniel Bevenius <[email protected]>
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Jon Moss <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
MylesBorins pushed a commit that referenced this pull request Dec 12, 2017
@Trott @MylesBorins
doc: add missing serial commas
e00923b 
PR-URL: #17384
Reviewed-By: Timothy Gu <[email protected]>
Reviewed-By: Alexey Orlenko <[email protected]>
Reviewed-By: Refael Ackermann <[email protected]>
Reviewed-By: Myles Borins <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Daniel Bevenius <[email protected]>
Reviewed-By: Gibson Fahnestock <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Jon Moss <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Tobias Nießen <[email protected]>
@MylesBorins MylesBorins mentioned this pull request Dec 12, 2017
Merged
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
@tniessen @guangwong
doc: use serial comma in cluster docs
0d5924d 
Refs: nodejs/node#11321
Refs: nodejs/node#17384

PR-URL: nodejs/node#42989
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Mohammed Keyvanzadeh <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
@tniessen @guangwong
doc: use serial comma in tls docs
9619219 
Refs: nodejs/node#11321
Refs: nodejs/node#17384

PR-URL: nodejs/node#43001
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Mohammed Keyvanzadeh <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
@tniessen @guangwong
doc: use serial comma in buffer docs
df2df40 
Refs: nodejs/node#11321
Refs: nodejs/node#17384

PR-URL: nodejs/node#43048
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Akhil Marsonya <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
@tniessen @guangwong
doc: use serial comma in util docs
4939899 
Refs: nodejs/node#11321
Refs: nodejs/node#17384

PR-URL: nodejs/node#43063
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Mohammed Keyvanzadeh <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
@tniessen @guangwong
doc: use serial comma in modules docs
1bdc035 
Refs: nodejs/node#11321
Refs: nodejs/node#17384

PR-URL: nodejs/node#43103
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
@tniessen @guangwong
doc: use serial comma in events docs
3d6e8e5 
Refs: nodejs/node#11321
Refs: nodejs/node#17384

PR-URL: nodejs/node#43113
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: LiviaMedeiros <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
@tniessen @guangwong
doc: use serial comma in dns docs
3548b60 
Refs: nodejs/node#11321
Refs: nodejs/node#17384

PR-URL: nodejs/node#43145
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Mohammed Keyvanzadeh <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
@tniessen @guangwong
doc: use serial comma in process docs
6c3e0f4 
Refs: nodejs/node#11321
Refs: nodejs/node#17384

PR-URL: nodejs/node#43179
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
@tniessen @guangwong
doc: use serial comma in dgram docs
5dd126a 
Refs: nodejs/node#11321
Refs: nodejs/node#17384

PR-URL: nodejs/node#43191
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Mohammed Keyvanzadeh <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
@tniessen @guangwong
doc: use serial comma in errors docs
9c032ed 
Refs: nodejs/node#11321
Refs: nodejs/node#17384

PR-URL: nodejs/node#43242
Reviewed-By: Mohammed Keyvanzadeh <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
@tniessen @guangwong
doc: use serial comma in console docs
664e5c5 
Refs: nodejs/node#11321
Refs: nodejs/node#17384

PR-URL: nodejs/node#43257
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Mohammed Keyvanzadeh <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
@tniessen @guangwong
doc: use serial comma in ESM docs
763521e 
Refs: nodejs/node#11321
Refs: nodejs/node#17384

PR-URL: nodejs/node#43322
Reviewed-By: Jacob Smith <[email protected]>
Reviewed-By: Mohammed Keyvanzadeh <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
@tniessen @guangwong
doc: use serial comma in net docs
704d1d1 
Refs: nodejs/node#11321
Refs: nodejs/node#17384

PR-URL: nodejs/node#43335
Reviewed-By: Mohammed Keyvanzadeh <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
@tniessen @guangwong
doc: use serial comma in webstreams docs
7514119 
Refs: nodejs/node#11321
Refs: nodejs/node#17384

PR-URL: nodejs/node#43353
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Mohammed Keyvanzadeh <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
@tniessen @guangwong
doc: use serial comma in report docs
4502f70 
Refs: nodejs/node#11321
Refs: nodejs/node#17384

PR-URL: nodejs/node#43394
Reviewed-By: Darshan Sen <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Harshitha K P <[email protected]>
Reviewed-By: Mohammed Keyvanzadeh <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
@tniessen @guangwong
doc: use serial comma in http docs
d715768 
Refs: nodejs/node#11321
Refs: nodejs/node#17384

PR-URL: nodejs/node#43026
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Mohammed Keyvanzadeh <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
@tniessen @guangwong
doc: use serial comma in fs docs
a0e8fd1 
Refs: nodejs/node#11321
Refs: nodejs/node#17384

PR-URL: nodejs/node#43104
Reviewed-By: LiviaMedeiros <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Darshan Sen <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
@tniessen @guangwong
doc: use serial comma in assert docs
0238160 
Refs: nodejs/node#11321
Refs: nodejs/node#17384

PR-URL: nodejs/node#43154
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Mohammed Keyvanzadeh <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
@tniessen @guangwong
doc: use serial comma in worker_threads docs
e861dcb 
Refs: nodejs/node#11321
Refs: nodejs/node#17384

PR-URL: nodejs/node#43220
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Mohammed Keyvanzadeh <[email protected]>
juanarbol pushed a commit that referenced this pull request Oct 10, 2022
@tniessen @juanarbol
doc: use serial comma in addons docs
15b3895 
Refs: #11321
Refs: #17384
PR-URL: #44482
Reviewed-By: Filip Skokan <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
juanarbol pushed a commit that referenced this pull request Oct 11, 2022
@tniessen @juanarbol
doc: use serial comma in addons docs
0e99139 
Refs: #11321
Refs: #17384
PR-URL: #44482
Reviewed-By: Filip Skokan <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Jan 3, 2023
@tniessen @guangwong
doc: use serial comma in addons docs
488ebf6 
Refs: nodejs/node#11321
Refs: nodejs/node#17384
PR-URL: nodejs/node#44482
Reviewed-By: Filip Skokan <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
guangwong pushed a commit to noslate-project/node that referenced this pull request Jan 3, 2023
@tniessen @guangwong
doc: use serial comma in addons docs
17e0dda 
Refs: nodejs/node#11321
Refs: nodejs/node#17384
PR-URL: nodejs/node#44482
Reviewed-By: Filip Skokan <[email protected]>
Reviewed-By: Antoine du Hamel <[email protected]>
tniessen added a commit to tniessen/node that referenced this pull request Mar 26, 2023
@tniessen
doc: use serial comma in cli docs
3de53f8 
Refs: nodejs#11321
Refs: nodejs#17384
@tniessen tniessen mentioned this pull request Mar 26, 2023
Merged
nodejs-github-bot pushed a commit that referenced this pull request Mar 27, 2023
@tniessen
doc: use serial comma in cli docs
f84ff93 
Refs: #11321
Refs: #17384
PR-URL: #47262
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Deokjin Kim <[email protected]>
RafaelGSS pushed a commit that referenced this pull request Apr 5, 2023
@tniessen @RafaelGSS
doc: use serial comma in cli docs
ee9052d 
Refs: #11321
Refs: #17384
PR-URL: #47262
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Deokjin Kim <[email protected]>
RafaelGSS pushed a commit that referenced this pull request Apr 6, 2023
@tniessen @RafaelGSS
doc: use serial comma in cli docs
db2109c 
Refs: #11321
Refs: #17384
PR-URL: #47262
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Deokjin Kim <[email protected]>
RafaelGSS pushed a commit that referenced this pull request Apr 7, 2023
@tniessen @RafaelGSS
doc: use serial comma in cli docs
0949f23 
Refs: #11321
Refs: #17384
PR-URL: #47262
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Deokjin Kim <[email protected]>
danielleadams pushed a commit that referenced this pull request Jul 6, 2023
@tniessen @danielleadams
doc: use serial comma in cli docs
faabd48 
Refs: #11321
Refs: #17384
PR-URL: #47262
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Deokjin Kim <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@lpinca lpinca lpinca approved these changes

@cjihrig cjihrig cjihrig approved these changes

@tniessen tniessen tniessen approved these changes

@richardlau richardlau richardlau approved these changes

@mhdawson mhdawson mhdawson approved these changes

+7 more reviewers

@refack refack refack approved these changes

@danbev danbev danbev approved these changes

@MylesBorins MylesBorins MylesBorins approved these changes

@TimothyGu TimothyGu TimothyGu approved these changes

@maclover7 maclover7 maclover7 approved these changes

@aqrln aqrln aqrln approved these changes

@gibfahn gibfahn gibfahn approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

doc Issues and PRs related to the documentations. fast-track PRs that do not need to wait for 48 hours to land.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.