Commit 3ff7c63
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 <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>1 parent 44fd3a2 commit 3ff7c63
1 file changed
Lines changed: 5 additions & 7 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -404,13 +404,11 @@ Runtime Deprecations and End-of-life APIs (internal or public) must be | |||
| 404 | 404 | handled as semver-major changes unless there is TSC consensus to land the | |
| 405 | 405 | deprecation as a semver-minor. | |
| 406 | 406 | ||
| 407 | - All Documentation-Only and Runtime deprecations will be assigned a unique | ||
| 408 | - identifier that can be used to persistently refer to the deprecation in | ||
| 409 | - documentation, emitted process warnings, or errors thrown. Documentation for | ||
| 410 | - these identifiers will be included in the Node.js API documentation and will | ||
| 411 | - be immutable once assigned. Even if End-of-Life code is removed from Node.js, | ||
| 412 | - the documentation for the assigned deprecation identifier must remain in the | ||
| 413 | - Node.js API documentation. | ||
| 407 | + All deprecations receive a unique and immutable identifier. Documentation, | ||
| 408 | + warnings, and errors use the identifier when referring to the deprecation. The | ||
| 409 | + documentation for the assigned deprecation identifier must always remain in the | ||
| 410 | + API documentation. This is true even if the deprecation is no longer in use (for | ||
| 411 | + example, due to removal of an End-of-Life deprecated API). | ||
| 414 | 412 | ||
| 415 | 413 | <a id="deprecation-cycle"></a> | |
| 416 | 414 | A _Deprecation cycle_ is a major release during which an API has been in one of | |
0 commit comments