From 28a54cb83a5ff277a8b56c942c6bd09465ed848a Mon Sep 17 00:00:00 2001 From: Ruben Bridgewater Date: Sat, 28 Apr 2018 17:22:19 +0200 Subject: [PATCH] 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: https://github.com/nodejs/node/pull/20381 Reviewed-By: Vse Mozhet Byt Reviewed-By: Anna Henningsen Reviewed-By: Trivikram Kamat Reviewed-By: Tiancheng "Timothy" Gu Reviewed-By: James M Snell --- COLLABORATOR_GUIDE.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/COLLABORATOR_GUIDE.md b/COLLABORATOR_GUIDE.md index 89c532e9d025f5..0f24dfa810d0b3 100644 --- a/COLLABORATOR_GUIDE.md +++ b/COLLABORATOR_GUIDE.md @@ -416,14 +416,15 @@ longer be used. Node.js uses three Deprecation levels: -* *Documentation-Only Deprecation* refers to elements of the Public API that are - being staged for deprecation in a future Node.js major release. An explicit - notice indicating the deprecated 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 by default. - Documentation-only deprecations may trigger a runtime warning when Node.js - is started with the [`--pending-deprecation`][] flag or the - `NODE_PENDING_DEPRECATION=1` environment variable is set. +* *Documentation-Only Deprecation* refers to elements of the Public API that + 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` + environment variable is set. * *Runtime Deprecation* refers to the use of process warnings emitted at runtime the first time that a deprecated API is used. A command-line