Skip to content

Commit 6ca4f03

Browse files
Trotttargos
authored andcommitted
doc: revise additional Experimental status text
Clarify and simplify material urging caution with Experimental features. PR-URL: #27931 Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
1 parent 6f9aa3f commit 6ca4f03

File tree

1 file changed

+6
-11
lines changed

1 file changed

+6
-11
lines changed

doc/api/documentation.md

+6-11
Original file line numberDiff line numberDiff line change
@@ -37,15 +37,11 @@ The stability indices are as follows:
3737
> Stability: 2 - Stable. Compatibility with the npm ecosystem is a high
3838
> priority.
3939
40-
Use caution when making use of `Experimental` features, particularly
41-
within modules that are dependencies (or dependencies of
42-
dependencies) within a Node.js application. End users may not be aware that
43-
experimental features are being used, and may experience unexpected
44-
failures or behavior changes when API modifications occur. To help avoid such
45-
surprises, `Experimental` features may require a command-line flag to
46-
enable them, or may emit a process warning.
47-
By default, such warnings are printed to [`stderr`][] and may be handled by
48-
attaching a listener to the [`'warning'`][] event.
40+
Use caution when making use of Experimental features, particularly within
41+
modules. End users may not be aware that experimental features are being used.
42+
Bugs or behavior changes may surprise end users when Experimental API
43+
modifications occur. To avoid surprises, use of an Experimental feature may need
44+
a command-line flag. Experimental features may also emit a [warning][].
4945

5046
## JSON Output
5147
<!-- YAML
@@ -68,9 +64,8 @@ relative to Linux and macOS. For an example of the subtle ways in which it's
6864
sometimes impossible to replace Unix syscall semantics on Windows, see [Node.js
6965
issue 4760](https://github.com/nodejs/node/issues/4760).
7066

71-
[`'warning'`]: process.html#process_event_warning
7267
[`fs.open()`]: fs.html#fs_fs_open_path_flags_mode_callback
73-
[`stderr`]: process.html#process_process_stderr
7468
[the contributing guide]: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
7569
[the issue tracker]: https://github.com/nodejs/node/issues/new
7670
[V8 JavaScript engine]: https://v8.dev/
71+
[warning]: process.html#process_event_warning

0 commit comments

Comments
 (0)