From a8d05ba2535d05ac1f1d74c183d4b7b1206f6fcf Mon Sep 17 00:00:00 2001 From: James M Snell Date: Wed, 17 Mar 2021 12:31:43 -0700 Subject: [PATCH] doc: add legacy status to stability index MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: James M Snell PR-URL: https://github.com/nodejs/node/pull/37784 Reviewed-By: Anna Henningsen Reviewed-By: Matteo Collina Reviewed-By: Vladimir de Turckheim Reviewed-By: Michaël Zasso Reviewed-By: Michael Dawson Reviewed-By: Beth Griggs --- doc/api/documentation.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/doc/api/documentation.md b/doc/api/documentation.md index a7a591d3733853..019040bdb61099 100644 --- a/doc/api/documentation.md +++ b/doc/api/documentation.md @@ -37,6 +37,12 @@ The stability indices are as follows: > Stability: 2 - Stable. Compatibility with the npm ecosystem is a high > priority. + + +> Stability: 3 - Legacy. The feature is no longer recommended for use. While it +likely will not be removed, and is still covered by semantic-versioning +guarantees, use of the feature should be avoided. + Use caution when making use of Experimental features, particularly within modules. Users may not be aware that experimental features are being used. Bugs or behavior changes may surprise users when Experimental API