Skip to content

Commit 717c44d

Browse files
committed
doc: make stability labels more consistent
PR-URL: #57516 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
1 parent b4576a6 commit 717c44d

14 files changed

+114
-84
lines changed

doc/api/buffer.md

-2
Original file line numberDiff line numberDiff line change
@@ -5356,8 +5356,6 @@ instance.
53565356
deprecated: v6.0.0
53575357
-->
53585358

5359-
> Stability: 0 - Deprecated: Use [`Buffer.allocUnsafeSlow()`][] instead.
5360-
53615359
* `size` {integer} The desired length of the new `SlowBuffer`.
53625360

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

doc/api/cli.md

+4-30
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ changes:
6161
Node.js options as well, in addition to V8 options.
6262
-->
6363

64+
> Stability: 2 - Stable
65+
6466
All options, including V8 options, allow words to be separated by both
6567
dashes (`-`) or underscores (`_`). For example, `--pending-deprecation` is
6668
equivalent to `--pending_deprecation`.
@@ -199,8 +201,6 @@ changes:
199201
description: Paths delimited by comma (`,`) are no longer allowed.
200202
-->
201203

202-
> Stability: 2 - Stable.
203-
204204
This flag configures file system read permissions using
205205
the [Permission Model][].
206206

@@ -244,8 +244,6 @@ changes:
244244
description: Paths delimited by comma (`,`) are no longer allowed.
245245
-->
246246

247-
> Stability: 2 - Stable.
248-
249247
This flag configures file system write permissions using
250248
the [Permission Model][].
251249

@@ -453,8 +451,6 @@ changes:
453451
description: The flag is no longer experimental.
454452
-->
455453

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

460456
Any number of custom string condition names are permitted.
@@ -480,8 +476,6 @@ changes:
480476
description: The `--cpu-prof` flags are now stable.
481477
-->
482478

483-
> Stability: 2 - Stable
484-
485479
Starts the V8 CPU profiler on start up, and writes the CPU profile to disk
486480
before exit.
487481

@@ -518,8 +512,6 @@ changes:
518512
description: The `--cpu-prof` flags are now stable.
519513
-->
520514

521-
> Stability: 2 - Stable
522-
523515
Specify the directory where the CPU profiles generated by `--cpu-prof` will
524516
be placed.
525517

@@ -538,8 +530,6 @@ changes:
538530
description: The `--cpu-prof` flags are now stable.
539531
-->
540532

541-
> Stability: 2 - Stable
542-
543533
Specify the sampling interval in microseconds for the CPU profiles generated
544534
by `--cpu-prof`. The default is 1000 microseconds.
545535

@@ -555,8 +545,6 @@ changes:
555545
description: The `--cpu-prof` flags are now stable.
556546
-->
557547

558-
> Stability: 2 - Stable
559-
560548
Specify the file name of the CPU profile generated by `--cpu-prof`.
561549

562550
### `--diagnostic-dir=directory`
@@ -1294,8 +1282,6 @@ changes:
12941282
description: The `--heap-prof` flags are now stable.
12951283
-->
12961284

1297-
> Stability: 2 - Stable
1298-
12991285
Starts the V8 heap profiler on start up, and writes the heap profile to disk
13001286
before exit.
13011287

@@ -1323,8 +1309,6 @@ changes:
13231309
description: The `--heap-prof` flags are now stable.
13241310
-->
13251311

1326-
> Stability: 2 - Stable
1327-
13281312
Specify the directory where the heap profiles generated by `--heap-prof` will
13291313
be placed.
13301314

@@ -1343,8 +1327,6 @@ changes:
13431327
description: The `--heap-prof` flags are now stable.
13441328
-->
13451329

1346-
> Stability: 2 - Stable
1347-
13481330
Specify the average sampling interval in bytes for the heap profiles generated
13491331
by `--heap-prof`. The default is 512 \* 1024 bytes.
13501332

@@ -1360,8 +1342,6 @@ changes:
13601342
description: The `--heap-prof` flags are now stable.
13611343
-->
13621344

1363-
> Stability: 2 - Stable
1364-
13651345
Specify the file name of the heap profile generated by `--heap-prof`.
13661346

13671347
### `--heapsnapshot-near-heap-limit=max_count`
@@ -1906,8 +1886,6 @@ changes:
19061886
description: Permission Model is now stable.
19071887
-->
19081888

1909-
> Stability: 2 - Stable.
1910-
19111889
Enable the Permission Model for current process. When enabled, the
19121890
following permissions are restricted:
19131891

@@ -2220,8 +2198,6 @@ changes:
22202198
`PATH` environment variable accordingly.
22212199
-->
22222200

2223-
> Stability: 2 - Stable
2224-
22252201
This runs a specified command from a package.json's `"scripts"` object.
22262202
If a missing `"command"` is provided, it will list the available scripts.
22272203

@@ -3019,8 +2995,6 @@ changes:
30192995
description: Test runner now supports running in watch mode.
30202996
-->
30212997

3022-
> Stability: 2 - Stable
3023-
30242998
Starts Node.js in watch mode.
30252999
When in watch mode, changes in the watched files cause the Node.js process to
30263000
restart.
@@ -3049,8 +3023,6 @@ changes:
30493023
description: Watch mode is now stable.
30503024
-->
30513025

3052-
> Stability: 2 - Stable
3053-
30543026
Starts Node.js in watch mode and specifies what paths to watch.
30553027
When in watch mode, changes in the watched paths cause the Node.js process to
30563028
restart.
@@ -3093,6 +3065,8 @@ instances.
30933065

30943066
## Environment variables
30953067

3068+
> Stability: 2 - Stable
3069+
30963070
### `FORCE_COLOR=[1, 2, 3]`
30973071

30983072
The `FORCE_COLOR` environment variable is used to

doc/api/diagnostics_channel.md

-12
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)
@@ -985,8 +975,6 @@ added:
985975
- v20.13.0
986976
-->
987977

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

doc/api/esm.md

-4
Original file line numberDiff line numberDiff line change
@@ -275,8 +275,6 @@ changes:
275275
description: Switch from Import Assertions to Import Attributes.
276276
-->
277277

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

@@ -640,8 +638,6 @@ changes:
640638
description: JSON modules are no longer experimental.
641639
-->
642640
643-
> Stability: 2 - Stable
644-
645641
JSON files can be referenced by `import`:
646642
647643
```js

doc/api/events.md

-4
Original file line numberDiff line numberDiff line change
@@ -2444,8 +2444,6 @@ changes:
24442444
description: No longer behind `--experimental-global-customevent` CLI flag.
24452445
-->
24462446
2447-
> Stability: 2 - Stable
2448-
24492447
* Extends: {Event}
24502448
24512449
The `CustomEvent` object is an adaptation of the [`CustomEvent` Web API][].
@@ -2465,8 +2463,6 @@ changes:
24652463
description: CustomEvent is now stable.
24662464
-->
24672465
2468-
> Stability: 2 - Stable
2469-
24702466
* Type: {any} Returns custom data passed when initializing.
24712467
24722468
Read-only.

0 commit comments

Comments
 (0)