Skip to content

Commit

Permalink
Revised text
Browse files Browse the repository at this point in the history
  • Loading branch information
jasnell committed May 11, 2017
1 parent b019389 commit 314b787
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions doc/api/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,20 +39,29 @@ The stability indices are as follows:

```txt
Stability: 0 - Deprecated
This feature is known to be problematic, and changes are planned. Do
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 should not be expected.
Backwards compatibility across major versions should not be expected.
```

```txt
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. The feature may only be usable
after using a command-line flag to enable it. Use of the feature may cause
warnings to be emitted.
is not recommended in production environments. Experimental features are not
subject to the Node.js Semantic Versioning model.
```

*Note*: Caution must be used when making use of `Experimental` features,
particularly within modules that may be used as dependencies (or dependencies
of dependencies) within a Node.js application. End users may not be aware that
experimental features are being used, and therefore may experience unexpected
failures or behavioral changes when changes occur. To help avoid such surprises,
`Experimental` features may require a command-line flag to explicitly enable
them, or may cause a process warning to be emitted. By default, such warnings
are printed to `stderr` and may be handled by attaching a listener to the
`process.on('warning')` event.

```txt
Stability: 2 - Stable
The API has proven satisfactory. Compatibility with the npm ecosystem
Expand Down

0 comments on commit 314b787

Please sign in to comment.