Commit 4662820
doc: edit text about revoking deprecations
* "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.
PR-URL: #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>1 parent 3b78f0d commit 4662820
1 file changed
Lines changed: 3 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -30,12 +30,11 @@ cause an error to be thrown. | |||
| 30 | 30 | An End-of-Life deprecation is used to identify code that either has been | |
| 31 | 31 | removed or will soon be removed from Node.js. | |
| 32 | 32 | ||
| 33 | - ## Un-deprecation | ||
| 33 | + ## Revoking deprecations | ||
| 34 | 34 | ||
| 35 | - From time-to-time the deprecation of an API may be reversed. Such action may | ||
| 36 | - happen in either a semver-minor or semver-major release. In such situations, | ||
| 35 | + Occasionally, the deprecation of an API may be reversed. In such situations, | ||
| 37 | 36 | this document will be updated with information relevant to the decision. | |
| 38 | - *However, the deprecation identifier will not be modified*. | ||
| 37 | + However, the deprecation identifier will not be modified. | ||
| 39 | 38 | ||
| 40 | 39 | ## List of Deprecated APIs | |
| 41 | 40 | ||
0 commit comments