Skip to content

Commit 8a627b1

Browse files
ChALkeRMylesBorins
authored andcommitted
doc: add pending-deprecation to COLLABORATOR_GUIDE
This is described as being a doc-only deprecation subset. Refs: #18417 PR-URL: #18433 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: Rich Trott <[email protected]>
1 parent b76e111 commit 8a627b1

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

COLLABORATOR_GUIDE.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -368,7 +368,10 @@ Node.js uses three Deprecation levels:
368368
being staged for deprecation in a future Node.js major release. An explicit
369369
notice indicating the deprecated status is added to the API documentation
370370
but no functional changes are implemented in the code. There will be no
371-
runtime deprecation warnings emitted for such deprecations.
371+
runtime deprecation warnings emitted for such deprecations by default.
372+
Documentation-only deprecations may trigger a runtime warning when launched
373+
with [`--pending-deprecation`][] flag (or its alternative,
374+
`NODE_PENDING_DEPRECATION=1` environment variable).
372375

373376
* *Runtime Deprecation* refers to the use of process warnings emitted at
374377
runtime the first time that a deprecated API is used. A command-line
@@ -744,6 +747,7 @@ LTS working group and the Release team.
744747
[backporting guide]: doc/guides/backporting-to-release-lines.md
745748
[Stability Index]: doc/api/documentation.md#stability-index
746749
[Enhancement Proposal]: https://github.com/nodejs/node-eps
750+
[`--pending-deprecation`]: doc/api/cli.md#--pending-deprecation
747751
[git-username]: https://help.github.com/articles/setting-your-username-in-git/
748752
[`node-core-utils`]: https://github.com/nodejs/node-core-utils
749753
[TSC]: https://github.com/nodejs/TSC

0 commit comments

Comments
 (0)