Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 34.2k
[v12.x backport] doc: remove em dashes#32146
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[v12.x backport] doc: remove em dashes #32146
Uh oh!
There was an error while loading. Please reload this page.
Conversation
They fail on OS X 10.15 (aka "Catalina"), but pass on earlier OS X. Refs: nodejs#30030 Refs: nodejs/build#2189 (comment) PR-URL: nodejs#31936 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Beth Griggs <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rod Vagg <[email protected]>
Our documentation uses em dashes inconsistently. They are treated inconsistently typographically too. (For example, they are sometimes surrounded by spaces and sometimes not.) They are also often confused with ordinary hyphens such as in the CHANGELOG, where they are inadvertently mixed together in a single list. The difference is not obvious in the raw markdown but is very noticeable when rendered, appearing to be a typographical error (which it in fact is). The em dash is never needed. There are always alternatives. Remove em dashes entirely. PR-URL: nodejs#32080 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
daabe16 to f5a4000Comparepuzpuzpuz commented Mar 8, 2020 • edited
Loading Uh oh!
There was an error while loading. Please reload this page.
edited
Uh oh!
There was an error while loading. Please reload this page.
It looks like Travis CI failed due to timeout in compilation phase. I've already seen such failure here: #32131 (comment) Both compilation and tests run successfully on my machine. |
This comment has been minimized.
This comment has been minimized.
puzpuzpuz commented Mar 8, 2020 • edited
Loading Uh oh!
There was an error while loading. Please reload this page.
edited
Uh oh!
There was an error while loading. Please reload this page.
It seems that there are some flaky tests remaining in
|
This comment has been minimized.
This comment has been minimized.
nodejs-github-bot commented Mar 8, 2020
puzpuzpuz commented Mar 9, 2020
@vdeturckheim@Qard guys, could one of you review this one? We need it to unblock #32131 |
vdeturckheim left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
puzpuzpuz commented Mar 10, 2020
Is there something I should do here or this PR is ready to land? I have no experience with backports in core, so that's why I'm asking. |
Trott commented Mar 10, 2020
Once a 12.x release is being prepared, someone on @nodejs/releasers will start landing these. I don't think there's anything to do here other than wait. Since 12.x is an LTS release, only releasers are supposed to land stuff to the 12.x-staging branch. |
puzpuzpuz commented Mar 10, 2020
codebytere commented Mar 14, 2020
They fail on OS X 10.15 (aka "Catalina"), but pass on earlier OS X. Refs: #30030 Refs: nodejs/build#2189 (comment) PR-URL: #31936 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Beth Griggs <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Rod Vagg <[email protected]> PR-URL: #32146 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Vladimir de Turckheim <[email protected]> Reviewed-By: Stephen Belanger <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Shelley Vohr <[email protected]>
Our documentation uses em dashes inconsistently. They are treated inconsistently typographically too. (For example, they are sometimes surrounded by spaces and sometimes not.) They are also often confused with ordinary hyphens such as in the CHANGELOG, where they are inadvertently mixed together in a single list. The difference is not obvious in the raw markdown but is very noticeable when rendered, appearing to be a typographical error (which it in fact is). The em dash is never needed. There are always alternatives. Remove em dashes entirely. PR-URL: #32080 Reviewed-By: Richard Lau <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> PR-URL: #32146 Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Vladimir de Turckheim <[email protected]> Reviewed-By: Stephen Belanger <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Shelley Vohr <[email protected]>
Backports the following PRs to
12.x-staging:Both of these PRs are necessary to have a successful build on
12.x-staging. See #32131 (comment) and #32131 (comment) to understand the context.Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes