1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: make Stability Index more concise

Browse Source 
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>
This commit is contained in:
Rich Trott 2018-08-26 18:30:48 -07:00 committed by George Adams
parent 503fd55a35
commit a0b5e6dbfd
No known key found for this signature in database
GPG Key ID: 7B8D7E4421A0916D
1 changed files with 8 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/api/documentation.md
View File

@ -34,24 +34,21 @@ and in the process of being redesigned.
The stability indices are as follows: The stability indices are as follows:
> Stability: 0 - Deprecated. This feature is known to be problematic, and > Stability: 0 - Deprecated. The feature may emit warnings. Backward
> changes may be planned. Do not rely on it. Use of the feature may cause > compatibility is not guaranteed.
> warnings to be emitted. Backwards compatibility across major versions should
> not be expected.
<!-- separator --> <!-- separator -->
> Stability: 1 - Experimental. This feature is still under active development > Stability: 1 - Experimental. This feature is still under active development
> and subject to non-backwards compatible changes, or even removal, in any > and subject to non-backward compatible changes or removal in any future
> future version. Use of the feature is not recommended in production > version. Use of the feature is not recommended in production environments.
> environments. Experimental features are not subject to the Node.js Semantic > Experimental features are not subject to the Node.js Semantic Versioning
> Versioning model. > model.
<!-- separator --> <!-- separator -->
> Stability: 2 - Stable. The API has proven satisfactory. Compatibility with the > Stability: 2 - Stable. Compatibility with the npm ecosystem is a high
> npm ecosystem is a high priority, and will not be broken unless absolutely > priority.
> necessary.
Caution must be used when making use of `Experimental` features, particularly Caution must be used when making use of `Experimental` features, particularly
within modules that may be used as dependencies (or dependencies of within modules that may be used as dependencies (or dependencies of