Skip to content

Commit 92cb53a

Browse files
committed
doc: clarify that features cannot be both experimental and deprecated
1 parent 53bcd11 commit 92cb53a

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

doc/api/deprecations.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ Node.js APIs might be deprecated for any of the following reasons:
1010
* An improved alternative API is available.
1111
* Breaking changes to the API are expected in a future major release.
1212

13+
Deprecated features are subject to [semantic versioning][] rules.
14+
1315
Node.js uses four kinds of deprecations:
1416

1517
* Documentation-only
@@ -4679,6 +4681,7 @@ deprecated and will throw an error in a future version.
46794681
[legacy URL API]: url.md#legacy-url-api
46804682
[legacy `urlObject`]: url.md#legacy-urlobject
46814683
[permission model]: permissions.md#permission-model
4684+
[semantic versioning]: https://semver.org/
46824685
[static methods of `crypto.Certificate()`]: crypto.md#class-certificate
46834686
[subpath exports]: packages.md#subpath-exports
46844687
[subpath imports]: packages.md#subpath-imports

doc/api/documentation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The stability indexes are as follows:
4646
> we can know that this feature is ready to be marked as stable.
4747
>
4848
> Experimental features leave the experimental status typically either by
49-
> graduating to stable, or are removed without a deprecation cycle.
49+
> graduating to stable, by being deprecated, or are removed without a deprecation cycle.
5050
5151
<!-- separator -->
5252

0 commit comments

Comments
 (0)