From 6ca4f03ccfd5e544336bb83bc1434fdd36f94c54 Mon Sep 17 00:00:00 2001 From: Rich Trott Date: Mon, 27 May 2019 22:59:03 -0700 Subject: [PATCH] doc: revise additional Experimental status text Clarify and simplify material urging caution with Experimental features. PR-URL: https://github.com/nodejs/node/pull/27931 Reviewed-By: Ruben Bridgewater Reviewed-By: Trivikram Kamat --- doc/api/documentation.md | 17 ++++++----------- 1 file changed, 6 insertions(+), 11 deletions(-) diff --git a/doc/api/documentation.md b/doc/api/documentation.md index 2d027101080dbe..b441e9806fed5b 100644 --- a/doc/api/documentation.md +++ b/doc/api/documentation.md @@ -37,15 +37,11 @@ The stability indices are as follows: > Stability: 2 - Stable. Compatibility with the npm ecosystem is a high > priority. -Use caution when making use of `Experimental` features, particularly -within modules that are dependencies (or dependencies of -dependencies) within a Node.js application. End users may not be aware that -experimental features are being used, and may experience unexpected -failures or behavior changes when API modifications occur. To help avoid such -surprises, `Experimental` features may require a command-line flag to -enable them, or may emit a process warning. -By default, such warnings are printed to [`stderr`][] and may be handled by -attaching a listener to the [`'warning'`][] event. +Use caution when making use of Experimental features, particularly within +modules. End users may not be aware that experimental features are being used. +Bugs or behavior changes may surprise end users when Experimental API +modifications occur. To avoid surprises, use of an Experimental feature may need +a command-line flag. Experimental features may also emit a [warning][]. ## JSON Output