diff options
| author | Rich Trott <rtrott@gmail.com> | 2019-02-28 22:16:24 -0800 |
|---|---|---|
| committer | Rich Trott <rtrott@gmail.com> | 2019-03-03 14:07:14 -0800 |
| commit | d773311c33f0d72931e188aba4bc4fd116fc80bd (patch) | |
| tree | a5601a709250c72a4c1f81e6bcdfcc9c2ebd3dbc /COLLABORATOR_GUIDE.md | |
| parent | ccaebdef66f62775ff8cc5d6fa21881a883c08fc (diff) | |
| download | android-node-v8-d773311c33f0d72931e188aba4bc4fd116fc80bd.tar.gz android-node-v8-d773311c33f0d72931e188aba4bc4fd116fc80bd.tar.bz2 android-node-v8-d773311c33f0d72931e188aba4bc4fd116fc80bd.zip | |
doc: edit deprecation identifier info in Collaborator Guide
Edit the deprecation identifier material in the Collaborator Guide for
simplicity and clarity.
PR-URL: https://github.com/nodejs/node/pull/26372
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com>
Diffstat (limited to 'COLLABORATOR_GUIDE.md')
| -rw-r--r-- | COLLABORATOR_GUIDE.md | 12 |
1 files changed, 5 insertions, 7 deletions
diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 9456d64c64..646bc408a5 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -347,13 +347,11 @@ Runtime Deprecations and End-of-life APIs (internal or public) are breaking changes (`semver-major`). The TSC may make exceptions, deciding that one of these deprecations is not a breaking change. -All Documentation-Only and Runtime deprecations will be assigned a unique -identifier that can be used to persistently refer to the deprecation in -documentation, emitted process warnings, or errors thrown. Documentation for -these identifiers will be included in the Node.js API documentation and will -be immutable once assigned. Even if End-of-Life code is removed from Node.js, -the documentation for the assigned deprecation identifier must remain in the -Node.js API documentation. +All deprecations receive a unique and immutable identifier. Documentation, +warnings, and errors use the identifier when referring to the deprecation. The +documentation for the assigned deprecation identifier must always remain in the +API documentation. This is true even if the deprecation is no longer in use (for +example, due to removal of an End-of-Life deprecated API). <a id="deprecation-cycle"></a> A _Deprecation cycle_ is a major release during which an API has been in one of |