From a0b5e6dbfdbc0094d5c73269b36470944b771464 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Sun, 26 Aug 2018 18:30:48 -0700 Subject: doc: make Stability Index more concise MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Shorten the Stability Index text. PR-URL: https://github.com/nodejs/node/pull/22544 Reviewed-By: Vse Mozhet Byt Reviewed-By: Luigi Pinca Reviewed-By: Sakthipriyan Vairamani Reviewed-By: Trivikram Kamat Reviewed-By: Minwoo Jung Reviewed-By: Colin Ihrig Reviewed-By: Tobias Nießen Reviewed-By: James M Snell --- doc/api/documentation.md | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) (limited to 'doc/api/documentation.md') 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. > 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. -> 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 -- cgit v1.2.3