doc: many small fixes to deprecations.md #20519
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
nodejs-github-bot
added
deprecations
vsemozhetbyt
approved these changes
May 4, 2018
vsemozhetbyt
added
the
author ready
refack
approved these changes
May 4, 2018
lpinca
approved these changes
May 4, 2018
doc/api/deprecations.md
Outdated
| @@ -925,7 +923,7 @@ This was never a documented feature. | |||
|
|
|||
| Type: End-of-Life | |||
|
|
|||
| The `--with-lttng` compile time option is removed. | |||
| The `--with-lttng` option has been removed. | |||
There was a problem hiding this comment.
Nit: I think "compile" was useful here.
There was a problem hiding this comment.
OK, put compile-time in there. Thanks.
BridgeAR
removed
the
author ready
Make the deprecation message a bit clear and concise.
Make the text slightly more concise. Fix awkward verb tense.
Fix awkward verb tense.
Make deprecation text slightly more concise and direct.
Fix a typographical error in deprecation text. Convert run-on sentence to two sentences (one in parentheses).
Make deprecation text more concise and direct.
Change `backwards compatibility` to `backward compatibility`. (It's confusing because "backwards compatible" is acceptable because "backwards" can be used as an adverb like that. However, as an adjective, as in "backward compatibility", only "backward" will do. Easiest solution: Always use "backward" because it is OK in both cases. This is all compounded by the US vs UK English thing. US English tends to favor "backward", and we standardize on US English, so that's another point in favor of "backward" over "backwards" in this context.)
Use "Node.js 6.0.0" instead of "Node.js v6.0.0". (We decided to drop "v" before version numbers to avoid confusion with the V8 JavaScript engine.)
* v10.0.0 -> Node.js 10.0.0 * Parenthetical with URL rather than "PR" as a lot of people may not know what "PR" stands for but they will know what a URL is. Plus not hiding the URL means the text is more copy/paste-able. In this particular case, "PR 12562" is not more useful or informative than nodejs#12562 so just use the URL.
* "un-deprecation" ಠ_ಠ -> "revoking deprecations" * "From time-to-time" -> "Occastionally" * "semver-major" and "semver-minor" are jargon that readers who don't follow our issue tracker will not know. Remove the sentence as it doesn't really impact end users. The deprecation is revoked when it is revoked. Rules around the releases where deprecations can be revoked may be added to the COLLABORATOR_GUIDE in the extensive section about deprecations there. If so, great, but let's still remove it here as having the information scattered in two places makes it likely that one will be edited to contradict the other and then it won't be clear which one is correct. * Remove unneeded italics. The italicized sentence is not hugely critical information that we desperately want users to know. Most users won't care. They will only care about the deprecation message that they are looking up at that moment.
|
Fixed a nit, co running Lite CI again: https://ci.nodejs.org/job/node-test-pull-request-lite/674/ |
jasnell
approved these changes
May 6, 2018
trivikr
approved these changes
May 6, 2018
Trott
added
the
author ready
Trott
added a commit
to Trott/io.js
that referenced
this pull request
May 7, 2018
Make the deprecation message a bit clear and concise. PR-URL: nodejs#20519 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Trott
added a commit
to Trott/io.js
that referenced
this pull request
May 7, 2018
Make the text slightly more concise. Fix awkward verb tense. PR-URL: nodejs#20519 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Trott
added a commit
to Trott/io.js
that referenced
this pull request
May 7, 2018
Fix awkward verb tense. PR-URL: nodejs#20519 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Trott
added a commit
to Trott/io.js
that referenced
this pull request
May 7, 2018
Make deprecation text slightly more concise and direct. PR-URL: nodejs#20519 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Trott
added a commit
to Trott/io.js
that referenced
this pull request
May 7, 2018
Fix a typographical error in deprecation text. Convert run-on sentence to two sentences (one in parentheses). PR-URL: nodejs#20519 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Trott
added a commit
to Trott/io.js
that referenced
this pull request
May 7, 2018
Make deprecation text more concise and direct. PR-URL: nodejs#20519 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Refael Ackermann <refack@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
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