Skip to content

Commit

Permalink
doc: make Stability Index more concise
Browse files Browse the repository at this point in the history
Shorten the Stability Index text.

PR-URL: #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>
  • Loading branch information
Trott authored and addaleax committed Aug 31, 2018
1 parent 6152888 commit 383162b
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions doc/api/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 383162b

Please sign in to comment.