Skip to content

Commit 4662820

Browse files
TrottMylesBorins
authored andcommitted
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 <[email protected]> Reviewed-By: Refael Ackermann <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
1 parent 3b78f0d commit 4662820

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

doc/api/deprecations.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,11 @@ cause an error to be thrown.
3030
An End-of-Life deprecation is used to identify code that either has been
3131
removed or will soon be removed from Node.js.
3232

33-
## Un-deprecation
33+
## Revoking deprecations
3434

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,
3736
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.
3938

4039
## List of Deprecated APIs
4140

0 commit comments

Comments
 (0)