Skip to content

doc: clearer doc-only deprecations #20381

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
BridgeAR wants to merge 2 commits into from
Closed

doc: clearer doc-only deprecations #20381

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e5aa5d4
doc: clearer doc-only deprecations
BridgeAR Apr 28, 2018
ab089bb
fixup: address comments
BridgeAR Apr 29, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
fixup: address comments
  • Loading branch information
@BridgeAR
BridgeAR committed Apr 29, 2018
commit ab089bbe8ea591f4211a7cc7bfb8728370cc304d
12 changes: 6 additions & 6 deletions COLLABORATOR_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -417,12 +417,12 @@ longer be used.
Node.js uses three Deprecation levels:

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

@vsemozhetbyt vsemozhetbyt Apr 28, 2018 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: maybe it is worth to also linkify [`NODE_PENDING_DEPRECATION=1`][] and add the bottom reference:

[`NODE_PENDING_DEPRECATION=1`]: doc/api/cli.md#node_pending_deprecation1

environment variable is set.

Expand Down