1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: revise additional Experimental status text

Browse Source 
Clarify and simplify material urging caution with Experimental features.

PR-URL: https://github.com/nodejs/node/pull/27931
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
This commit is contained in:
Rich Trott 2019-05-27 22:59:03 -07:00
parent 76cffddf82
commit ff4a71ccc3
1 changed files with 6 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/api/documentation.md
View File

@ -37,15 +37,11 @@ The stability indices are as follows:
> Stability: 2 - Stable. Compatibility with the npm ecosystem is a high > Stability: 2 - Stable. Compatibility with the npm ecosystem is a high
> priority. > priority.
Use caution when making use of `Experimental` features, particularly Use caution when making use of Experimental features, particularly within
within modules that are dependencies (or dependencies of modules. End users may not be aware that experimental features are being used.
dependencies) within a Node.js application. End users may not be aware that Bugs or behavior changes may surprise end users when Experimental API
experimental features are being used, and may experience unexpected modifications occur. To avoid surprises, use of an Experimental feature may need
failures or behavior changes when API modifications occur. To help avoid such a command-line flag. Experimental features may also emit a [warning][].
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.
## JSON Output ## JSON Output
<!-- YAML <!-- YAML
@ -68,9 +64,8 @@ relative to Linux and macOS. For an example of the subtle ways in which it's
sometimes impossible to replace Unix syscall semantics on Windows, see [Node.js sometimes impossible to replace Unix syscall semantics on Windows, see [Node.js
issue 4760](https://github.com/nodejs/node/issues/4760). issue 4760](https://github.com/nodejs/node/issues/4760).
[`'warning'`]: process.html#process_event_warning
[`fs.open()`]: fs.html#fs_fs_open_path_flags_mode_callback [`fs.open()`]: fs.html#fs_fs_open_path_flags_mode_callback
[`stderr`]: process.html#process_process_stderr
[the contributing guide]: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md [the contributing guide]: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
[the issue tracker]: https://github.com/nodejs/node/issues/new [the issue tracker]: https://github.com/nodejs/node/issues/new
[V8 JavaScript engine]: https://v8.dev/ [V8 JavaScript engine]: https://v8.dev/
[warning]: process.html#process_event_warning