Serial comma #17384

Trott · 2017-11-29T02:58:54Z

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

There is nothing controversial about serial commas and there is no need to hedge bets on it. Simply instruct people to use serial commas.

MylesBorins

LGTM
Don't think this needs to wait 48 hours

gibfahn · 2017-11-29T12:23:40Z

doc/STYLE_GUIDE.md

@@ -75,6 +75,6 @@

 [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


Pretty outraged about this change 😉 .

gibfahn · 2017-11-29T12:25:56Z

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

LGTM

mhdawson

LGTM

richardlau

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 · 2017-12-01T01:24:13Z

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 · 2017-12-01T07:44:11Z

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

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]>

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 · 2017-12-01T22:48:24Z

Landed in d2b2baf and ff9a6bc.

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]>

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]>

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]>

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]>

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]>

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]>

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]>

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]>

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]>

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]>

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]>

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]>

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]>

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]>

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]>

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]>

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]>

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]>

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]>

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]>

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]>

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]>

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]>

Refs: #11321 Refs: #17384 PR-URL: #44482 Reviewed-By: Filip Skokan <[email protected]> Reviewed-By: Antoine du Hamel <[email protected]>

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]>

Refs: nodejs#11321 Refs: nodejs#17384

Refs: #11321 Refs: #17384 PR-URL: #47262 Reviewed-By: Moshe Atlow <[email protected]> Reviewed-By: Deokjin Kim <[email protected]>

Trott added 2 commits November 28, 2017 21:37

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.

doc: add missing serial commas

a95ce6b

nodejs-github-bot added the doc Issues and PRs related to the documentations. label Nov 29, 2017

TimothyGu approved these changes Nov 29, 2017

View reviewed changes

aqrln approved these changes Nov 29, 2017

View reviewed changes

refack approved these changes Nov 29, 2017

View reviewed changes

MylesBorins approved these changes Nov 29, 2017

View reviewed changes

MylesBorins added the fast-track PRs that do not need to wait for 48 hours to land. label Nov 29, 2017

lpinca approved these changes Nov 29, 2017

View reviewed changes

danbev approved these changes Nov 29, 2017

View reviewed changes

gibfahn approved these changes Nov 29, 2017

View reviewed changes

cjihrig approved these changes Nov 29, 2017

View reviewed changes

maclover7 approved these changes Nov 29, 2017

View reviewed changes

mhdawson approved these changes Nov 29, 2017

View reviewed changes

richardlau approved these changes Nov 29, 2017

View reviewed changes

tniessen approved these changes Dec 1, 2017

View reviewed changes

Trott closed this Dec 1, 2017

MylesBorins mentioned this pull request Dec 12, 2017

v9.3.0 proposal #17631

Merged

juanarbol pushed a commit that referenced this pull request Oct 10, 2022

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

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]>

tniessen added a commit to tniessen/node that referenced this pull request Mar 26, 2023

doc: use serial comma in cli docs

3de53f8

Refs: nodejs#11321 Refs: nodejs#17384

tniessen mentioned this pull request Mar 26, 2023

doc: use serial comma in cli docs #47262

Merged

nodejs-github-bot pushed a commit that referenced this pull request Mar 27, 2023

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

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

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

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

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]>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Serial comma #17384

Serial comma #17384

Trott commented Nov 29, 2017

MylesBorins left a comment

gibfahn Nov 29, 2017

gibfahn commented Nov 29, 2017

maclover7 left a comment

mhdawson left a comment

richardlau left a comment

Trott commented Dec 1, 2017 •

edited

Loading

Trott commented Dec 1, 2017

Trott commented Dec 1, 2017

Serial comma #17384

Serial comma #17384

Conversation

Trott commented Nov 29, 2017

Checklist

Affected core subsystem(s)

MylesBorins left a comment

Choose a reason for hiding this comment

gibfahn Nov 29, 2017

Choose a reason for hiding this comment

gibfahn commented Nov 29, 2017

maclover7 left a comment

Choose a reason for hiding this comment

mhdawson left a comment

Choose a reason for hiding this comment

richardlau left a comment

Choose a reason for hiding this comment

Trott commented Dec 1, 2017 • edited Loading

Trott commented Dec 1, 2017

Trott commented Dec 1, 2017

Trott commented Dec 1, 2017 •

edited

Loading