diff options
| author | Darshan Sen <raisinten@gmail.com> | 2022-03-14 08:10:08 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-14 08:10:08 +0300 |
| commit | 625c1e841adee3e687225597e60c70df6510a696 (patch) | |
| tree | 063534bc86d0195a74f769127a8391b5835e58f6 /doc/api/documentation.md | |
| parent | b481beecd803397940b2c4d0ed17d266ba5c1405 (diff) | |
doc: clarify the meaning of legacy status
Fixes: https://github.com/nodejs/node/issues/42230
Fixes: https://github.com/nodejs/node/issues/42232
Signed-off-by: Darshan Sen <raisinten@gmail.com>
PR-URL: https://github.com/nodejs/node/pull/42269
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Reviewed-By: Mestery <mestery@protonmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Mohammed Keyvanzadeh <mohammadkeyvanzade94@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Diffstat (limited to 'doc/api/documentation.md')
| -rw-r--r-- | doc/api/documentation.md | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/api/documentation.md b/doc/api/documentation.md index be5e7671f8d..71e0b49206e 100644 --- a/doc/api/documentation.md +++ b/doc/api/documentation.md @@ -40,9 +40,13 @@ The stability indices are as follows: <!-- separator --> -> 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. +> Stability 3 - Legacy. Although this feature is unlikely to be removed and is +> still covered by semantic-versioning guarantees, it is no longer actively +> maintained, and other alternatives are available. + +Features are marked as legacy rather than being deprecated if their use does no +harm, and they are widely relied upon within the npm ecosystem. Bugs found in +legacy features are unlikely to be fixed. Use caution when making use of Experimental features, particularly within modules. Users may not be aware that experimental features are being used. |