diff options
| -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 |