Skip to content

Commit 846cba0

Browse files
TrottBridgeAR
authored andcommittedMar 4, 2019
doc: edit deprecation identifier info in Collaborator Guide
Edit the deprecation identifier material in the Collaborator Guide for simplicity and clarity. PR-URL: #26372 Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Сковорода Никита Андреевич <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Anto Aravinth <[email protected]>
1 parent 030b744 commit 846cba0

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed
 

‎COLLABORATOR_GUIDE.md

+5-7
Original file line numberDiff line numberDiff line change
@@ -347,13 +347,11 @@ Runtime Deprecations and End-of-life APIs (internal or public) are breaking
347347
changes (`semver-major`). The TSC may make exceptions, deciding that one of
348348
these deprecations is not a breaking change.
349349

350-
All Documentation-Only and Runtime deprecations will be assigned a unique
351-
identifier that can be used to persistently refer to the deprecation in
352-
documentation, emitted process warnings, or errors thrown. Documentation for
353-
these identifiers will be included in the Node.js API documentation and will
354-
be immutable once assigned. Even if End-of-Life code is removed from Node.js,
355-
the documentation for the assigned deprecation identifier must remain in the
356-
Node.js API documentation.
350+
All deprecations receive a unique and immutable identifier. Documentation,
351+
warnings, and errors use the identifier when referring to the deprecation. The
352+
documentation for the assigned deprecation identifier must always remain in the
353+
API documentation. This is true even if the deprecation is no longer in use (for
354+
example, due to removal of an End-of-Life deprecated API).
357355

358356
<a id="deprecation-cycle"></a>
359357
A _Deprecation cycle_ is a major release during which an API has been in one of

0 commit comments

Comments
 (0)