Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Commit 5de1771

Browse filesBrowse files
BridgeARMylesBorins
authored andcommitted
doc: clearer doc-only deprecations
Explicitely mention that a documentation only deprecation does not always imply that it will be staged for deprecation in a future Node.js major release. It is mainly there to tell developers that a specific API should be avoided. PR-URL: #20381 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
1 parent b215f92 commit 5de1771
Copy full SHA for 5de1771

File tree

Expand file treeCollapse file tree

1 file changed

+9
-8
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

1 file changed

+9
-8
lines changed
Open diff view settings
Collapse file

‎COLLABORATOR_GUIDE.md‎

Copy file name to clipboardExpand all lines: COLLABORATOR_GUIDE.md
+9-8Lines changed: 9 additions & 8 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -416,14 +416,15 @@ longer be used.
416416

417417
Node.js uses three Deprecation levels:
418418

419-
* *Documentation-Only Deprecation* refers to elements of the Public API that are
420-
being staged for deprecation in a future Node.js major release. An explicit
421-
notice indicating the deprecated status is added to the API documentation
422-
but no functional changes are implemented in the code. There will be no
423-
runtime deprecation warnings emitted for such deprecations by default.
424-
Documentation-only deprecations may trigger a runtime warning when Node.js
425-
is started with the [`--pending-deprecation`][] flag or the
426-
`NODE_PENDING_DEPRECATION=1` environment variable is set.
419+
* *Documentation-Only Deprecation* refers to elements of the Public API that
420+
should be avoided by developers and that might be staged for a runtime
421+
deprecation in a future Node.js major release. An explicit notice indicating
422+
the deprecation status is added to the API documentation but no functional
423+
changes are implemented in the code. By default there will be no deprecation
424+
warnings emitted for such deprecations at runtime. Documentation-only
425+
deprecations may trigger a runtime warning when Node.js is started with the
426+
[`--pending-deprecation`][] flag or the `NODE_PENDING_DEPRECATION=1`
427+
environment variable is set.
427428

428429
* *Runtime Deprecation* refers to the use of process warnings emitted at
429430
runtime the first time that a deprecated API is used. A command-line

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.