Skip to content

Commit 524c078

Browse files
authored
doc: make stability labels more consistent
PR-URL: #57516 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Matteo Collina <[email protected]>
1 parent e6a4155 commit 524c078

15 files changed

+116
-88
lines changed

doc/api/assert.md

-2
Original file line numberDiff line numberDiff line change
@@ -2600,8 +2600,6 @@ changes:
26002600
description: partialDeepStrictEqual is now Stable. Previously, it had been Experimental.
26012601
-->
26022602

2603-
> Stability: 2 - Stable
2604-
26052603
* `actual` {any}
26062604
* `expected` {any}
26072605
* `message` {string|Error}

doc/api/buffer.md

-2
Original file line numberDiff line numberDiff line change
@@ -5358,8 +5358,6 @@ instance.
53585358
deprecated: v6.0.0
53595359
-->
53605360

5361-
> Stability: 0 - Deprecated: Use [`Buffer.allocUnsafeSlow()`][] instead.
5362-
53635361
* `size` {integer} The desired length of the new `SlowBuffer`.
53645362

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

doc/api/cli.md

+4-32
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`.
@@ -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

@@ -248,8 +248,6 @@ changes:
248248
description: Paths delimited by comma (`,`) are no longer allowed.
249249
-->
250250

251-
> Stability: 2 - Stable.
252-
253251
This flag configures file system write permissions using
254252
the [Permission Model][].
255253

@@ -457,8 +455,6 @@ changes:
457455
description: The flag is no longer experimental.
458456
-->
459457

460-
> Stability: 2 - Stable
461-
462458
Provide custom [conditional exports][] resolution conditions.
463459

464460
Any number of custom string condition names are permitted.
@@ -484,8 +480,6 @@ changes:
484480
description: The `--cpu-prof` flags are now stable.
485481
-->
486482

487-
> Stability: 2 - Stable
488-
489483
Starts the V8 CPU profiler on start up, and writes the CPU profile to disk
490484
before exit.
491485

@@ -522,8 +516,6 @@ changes:
522516
description: The `--cpu-prof` flags are now stable.
523517
-->
524518

525-
> Stability: 2 - Stable
526-
527519
Specify the directory where the CPU profiles generated by `--cpu-prof` will
528520
be placed.
529521

@@ -542,8 +534,6 @@ changes:
542534
description: The `--cpu-prof` flags are now stable.
543535
-->
544536

545-
> Stability: 2 - Stable
546-
547537
Specify the sampling interval in microseconds for the CPU profiles generated
548538
by `--cpu-prof`. The default is 1000 microseconds.
549539

@@ -559,8 +549,6 @@ changes:
559549
description: The `--cpu-prof` flags are now stable.
560550
-->
561551

562-
> Stability: 2 - Stable
563-
564552
Specify the file name of the CPU profile generated by `--cpu-prof`.
565553

566554
### `--diagnostic-dir=directory`
@@ -1295,8 +1283,6 @@ changes:
12951283
description: The `--heap-prof` flags are now stable.
12961284
-->
12971285

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

@@ -1324,8 +1310,6 @@ changes:
13241310
description: The `--heap-prof` flags are now stable.
13251311
-->
13261312

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

@@ -1344,8 +1328,6 @@ changes:
13441328
description: The `--heap-prof` flags are now stable.
13451329
-->
13461330

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

@@ -1361,8 +1343,6 @@ changes:
13611343
description: The `--heap-prof` flags are now stable.
13621344
-->
13631345

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

13681348
### `--heapsnapshot-near-heap-limit=max_count`
@@ -1695,8 +1675,6 @@ requiring a native C++ addon will fail and throw an exception.
16951675
added: REPLACEME
16961676
-->
16971677

1698-
> Stability: 2 - Stable
1699-
17001678
Disables the use of [`AsyncLocalStorage`][] backed by `AsyncContextFrame` and
17011679
uses the prior implementation which relied on async\_hooks. The previous model
17021680
is retained for compatibility with Electron and for cases where the context
@@ -1928,8 +1906,6 @@ changes:
19281906
description: Permission Model is now stable.
19291907
-->
19301908

1931-
> Stability: 2 - Stable.
1932-
19331909
Enable the Permission Model for current process. When enabled, the
19341910
following permissions are restricted:
19351911

@@ -2244,8 +2220,6 @@ changes:
22442220
`PATH` environment variable accordingly.
22452221
-->
22462222

2247-
> Stability: 2 - Stable
2248-
22492223
This runs a specified command from a package.json's `"scripts"` object.
22502224
If a missing `"command"` is provided, it will list the available scripts.
22512225

@@ -3053,8 +3027,6 @@ changes:
30533027
description: Test runner now supports running in watch mode.
30543028
-->
30553029

3056-
> Stability: 2 - Stable
3057-
30583030
Starts Node.js in watch mode.
30593031
When in watch mode, changes in the watched files cause the Node.js process to
30603032
restart.
@@ -3083,8 +3055,6 @@ changes:
30833055
description: Watch mode is now stable.
30843056
-->
30853057

3086-
> Stability: 2 - Stable
3087-
30883058
Starts Node.js in watch mode and specifies what paths to watch.
30893059
When in watch mode, changes in the watched paths cause the Node.js process to
30903060
restart.
@@ -3127,6 +3097,8 @@ instances.
31273097

31283098
## Environment variables
31293099

3100+
> Stability: 2 - Stable
3101+
31303102
### `FORCE_COLOR=[1, 2, 3]`
31313103

31323104
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
@@ -279,8 +279,6 @@ changes:
279279
description: Switch from Import Assertions to Import Attributes.
280280
-->
281281

282-
> Stability: 2 - Stable
283-
284282
[Import attributes][Import Attributes MDN] are an inline syntax for module import
285283
statements to pass on more information alongside the module specifier.
286284

@@ -648,8 +646,6 @@ changes:
648646
description: JSON modules are no longer experimental.
649647
-->
650648
651-
> Stability: 2 - Stable
652-
653649
JSON files can be referenced by `import`:
654650
655651
```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)