Skip to content

Commit 37e360e

Browse files
committed
doc: make stability labels more consistent
PR-URL: #57516 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
1 parent 4e02a16 commit 37e360e

File tree

13 files changed

+108
-78
lines changed

13 files changed

+108
-78
lines changed

doc/api/buffer.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5352,8 +5352,6 @@ instance.
53525352
deprecated: v6.0.0
53535353
-->
53545354

5355-
> Stability: 0 - Deprecated: Use [`Buffer.allocUnsafeSlow()`][] instead.
5356-
53575355
* `size` {integer} The desired length of the new `SlowBuffer`.
53585356

53595357
See [`Buffer.allocUnsafeSlow()`][].

doc/api/cli.md

Lines changed: 4 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,8 @@ changes:
6363
Node.js options as well, in addition to V8 options.
6464
-->
6565

66+
> Stability: 2 - Stable
67+
6668
All options, including V8 options, allow words to be separated by both
6769
dashes (`-`) or underscores (`_`). For example, `--pending-deprecation` is
6870
equivalent to `--pending_deprecation`.
@@ -201,8 +203,6 @@ changes:
201203
description: Paths delimited by comma (`,`) are no longer allowed.
202204
-->
203205

204-
> Stability: 2 - Stable.
205-
206206
This flag configures file system read permissions using
207207
the [Permission Model][].
208208

@@ -246,8 +246,6 @@ changes:
246246
description: Paths delimited by comma (`,`) are no longer allowed.
247247
-->
248248

249-
> Stability: 2 - Stable.
250-
251249
This flag configures file system write permissions using
252250
the [Permission Model][].
253251

@@ -452,8 +450,6 @@ changes:
452450
description: The flag is no longer experimental.
453451
-->
454452

455-
> Stability: 2 - Stable
456-
457453
Provide custom [conditional exports][] resolution conditions.
458454

459455
Any number of custom string condition names are permitted.
@@ -478,8 +474,6 @@ changes:
478474
description: The `--cpu-prof` flags are now stable.
479475
-->
480476

481-
> Stability: 2 - Stable
482-
483477
Starts the V8 CPU profiler on start up, and writes the CPU profile to disk
484478
before exit.
485479

@@ -515,8 +509,6 @@ changes:
515509
description: The `--cpu-prof` flags are now stable.
516510
-->
517511

518-
> Stability: 2 - Stable
519-
520512
Specify the directory where the CPU profiles generated by `--cpu-prof` will
521513
be placed.
522514

@@ -534,8 +526,6 @@ changes:
534526
description: The `--cpu-prof` flags are now stable.
535527
-->
536528

537-
> Stability: 2 - Stable
538-
539529
Specify the sampling interval in microseconds for the CPU profiles generated
540530
by `--cpu-prof`. The default is 1000 microseconds.
541531

@@ -550,8 +540,6 @@ changes:
550540
description: The `--cpu-prof` flags are now stable.
551541
-->
552542

553-
> Stability: 2 - Stable
554-
555543
Specify the file name of the CPU profile generated by `--cpu-prof`.
556544

557545
### `--diagnostic-dir=directory`
@@ -1324,8 +1312,6 @@ changes:
13241312
description: The `--heap-prof` flags are now stable.
13251313
-->
13261314

1327-
> Stability: 2 - Stable
1328-
13291315
Starts the V8 heap profiler on start up, and writes the heap profile to disk
13301316
before exit.
13311317

@@ -1352,8 +1338,6 @@ changes:
13521338
description: The `--heap-prof` flags are now stable.
13531339
-->
13541340

1355-
> Stability: 2 - Stable
1356-
13571341
Specify the directory where the heap profiles generated by `--heap-prof` will
13581342
be placed.
13591343

@@ -1371,8 +1355,6 @@ changes:
13711355
description: The `--heap-prof` flags are now stable.
13721356
-->
13731357

1374-
> Stability: 2 - Stable
1375-
13761358
Specify the average sampling interval in bytes for the heap profiles generated
13771359
by `--heap-prof`. The default is 512 \* 1024 bytes.
13781360

@@ -1387,8 +1369,6 @@ changes:
13871369
description: The `--heap-prof` flags are now stable.
13881370
-->
13891371

1390-
> Stability: 2 - Stable
1391-
13921372
Specify the file name of the heap profile generated by `--heap-prof`.
13931373

13941374
### `--heapsnapshot-near-heap-limit=max_count`
@@ -1935,8 +1915,6 @@ changes:
19351915
description: Permission Model is now stable.
19361916
-->
19371917

1938-
> Stability: 2 - Stable.
1939-
19401918
Enable the Permission Model for current process. When enabled, the
19411919
following permissions are restricted:
19421920

@@ -2252,8 +2230,6 @@ changes:
22522230
`PATH` environment variable accordingly.
22532231
-->
22542232

2255-
> Stability: 2 - Stable
2256-
22572233
This runs a specified command from a package.json's `"scripts"` object.
22582234
If a missing `"command"` is provided, it will list the available scripts.
22592235

@@ -3060,8 +3036,6 @@ changes:
30603036
description: Test runner now supports running in watch mode.
30613037
-->
30623038

3063-
> Stability: 2 - Stable
3064-
30653039
Starts Node.js in watch mode.
30663040
When in watch mode, changes in the watched files cause the Node.js process to
30673041
restart.
@@ -3088,8 +3062,6 @@ changes:
30883062
description: Watch mode is now stable.
30893063
-->
30903064

3091-
> Stability: 2 - Stable
3092-
30933065
Starts Node.js in watch mode and specifies what paths to watch.
30943066
When in watch mode, changes in the watched paths cause the Node.js process to
30953067
restart.
@@ -3132,6 +3104,8 @@ instances.
31323104

31333105
## Environment variables
31343106

3107+
> Stability: 2 - Stable
3108+
31353109
### `FORCE_COLOR=[1, 2, 3]`
31363110

31373111
The `FORCE_COLOR` environment variable is used to

doc/api/diagnostics_channel.md

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -635,8 +635,6 @@ added:
635635
- v18.19.0
636636
-->
637637

638-
> Stability: 1 - Experimental
639-
640638
* `subscribers` {Object} Set of [TracingChannel Channels][] subscribers
641639
* `start` {Function} The [`start` event][] subscriber
642640
* `end` {Function} The [`end` event][] subscriber
@@ -704,8 +702,6 @@ added:
704702
- v18.19.0
705703
-->
706704

707-
> Stability: 1 - Experimental
708-
709705
* `subscribers` {Object} Set of [TracingChannel Channels][] subscribers
710706
* `start` {Function} The [`start` event][] subscriber
711707
* `end` {Function} The [`end` event][] subscriber
@@ -775,8 +771,6 @@ added:
775771
- v18.19.0
776772
-->
777773

778-
> Stability: 1 - Experimental
779-
780774
* `fn` {Function} Function to wrap a trace around
781775
* `context` {Object} Shared object to correlate events through
782776
* `thisArg` {any} The receiver to be used for the function call
@@ -826,8 +820,6 @@ added:
826820
- v18.19.0
827821
-->
828822

829-
> Stability: 1 - Experimental
830-
831823
* `fn` {Function} Promise-returning function to wrap a trace around
832824
* `context` {Object} Shared object to correlate trace events through
833825
* `thisArg` {any} The receiver to be used for the function call
@@ -880,8 +872,6 @@ added:
880872
- v18.19.0
881873
-->
882874

883-
> Stability: 1 - Experimental
884-
885875
* `fn` {Function} callback using function to wrap a trace around
886876
* `position` {number} Zero-indexed argument position of expected callback
887877
(defaults to last argument if `undefined` is passed)
@@ -984,8 +974,6 @@ added:
984974
- v22.0.0
985975
-->
986976

987-
> Stability: 1 - Experimental
988-
989977
* Returns: {boolean} `true` if any of the individual channels has a subscriber,
990978
`false` if not.
991979

doc/api/esm.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -276,8 +276,6 @@ changes:
276276
description: Switch from Import Assertions to Import Attributes.
277277
-->
278278

279-
> Stability: 2 - Stable
280-
281279
[Import attributes][Import Attributes MDN] are an inline syntax for module import
282280
statements to pass on more information alongside the module specifier.
283281

@@ -624,8 +622,6 @@ changes:
624622
description: JSON modules are no longer experimental.
625623
-->
626624
627-
> Stability: 2 - Stable
628-
629625
JSON files can be referenced by `import`:
630626
631627
```js

doc/api/events.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2441,8 +2441,6 @@ changes:
24412441
description: No longer behind `--experimental-global-customevent` CLI flag.
24422442
-->
24432443
2444-
> Stability: 2 - Stable
2445-
24462444
* Extends: {Event}
24472445
24482446
The `CustomEvent` object is an adaptation of the [`CustomEvent` Web API][].
@@ -2460,8 +2458,6 @@ changes:
24602458
description: CustomEvent is now stable.
24612459
-->
24622460
2463-
> Stability: 2 - Stable
2464-
24652461
* Type: {any} Returns custom data passed when initializing.
24662462
24672463
Read-only.

0 commit comments

Comments
 (0)