diff options
| author | Rich Trott <rtrott@gmail.com> | 2018-08-27 04:30:48 +0300 |
|---|---|---|
| committer | George Adams <george.adams@uk.ibm.com> | 2018-08-30 22:15:40 +0300 |
| commit | a0b5e6dbfdbc0094d5c73269b36470944b771464 (patch) | |
| tree | 708b1efeb91382183c6ce37f7f4b698912cffaee /doc/api/documentation.md | |
| parent | 503fd55a35ce056d636c15811c07b51126af271a (diff) | |
doc: make Stability Index more concise
Shorten the Stability Index text.
PR-URL: https://github.com/nodejs/node/pull/22544
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Minwoo Jung <minwoo@nodesource.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc/api/documentation.md')
| -rw-r--r-- | doc/api/documentation.md | 19 |
1 files changed, 8 insertions, 11 deletions
diff --git a/doc/api/documentation.md b/doc/api/documentation.md index f9fa9591af9..afad0e653ef 100644 --- a/doc/api/documentation.md +++ b/doc/api/documentation.md @@ -34,24 +34,21 @@ and in the process of being redesigned. The stability indices are as follows: -> Stability: 0 - Deprecated. This feature is known to be problematic, and -> changes may be planned. Do not rely on it. Use of the feature may cause -> warnings to be emitted. Backwards compatibility across major versions should -> not be expected. +> Stability: 0 - Deprecated. The feature may emit warnings. Backward +> compatibility is not guaranteed. <!-- separator --> > Stability: 1 - Experimental. This feature is still under active development -> and subject to non-backwards compatible changes, or even removal, in any -> future version. Use of the feature is not recommended in production -> environments. Experimental features are not subject to the Node.js Semantic -> Versioning model. +> and subject to non-backward compatible changes or removal in any future +> version. Use of the feature is not recommended in production environments. +> Experimental features are not subject to the Node.js Semantic Versioning +> model. <!-- separator --> -> Stability: 2 - Stable. The API has proven satisfactory. Compatibility with the -> npm ecosystem is a high priority, and will not be broken unless absolutely -> necessary. +> Stability: 2 - Stable. Compatibility with the npm ecosystem is a high +> priority. Caution must be used when making use of `Experimental` features, particularly within modules that may be used as dependencies (or dependencies of |