Skip to content

doc: clarify that features cannot be both experimental and deprecated #62456

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aduh95 wants to merge 2 commits into
base: main
Choose a base branch
from
+6 −1
Open

doc: clarify that features cannot be both experimental and deprecated #62456

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
92cb53a
doc: clarify that features cannot be both experimental and deprecated
aduh95 Mar 27, 2026
44572ae
fixup! doc: clarify that features cannot be both experimental and dep…
aduh95 Mar 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions doc/api/deprecations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Node.js APIs might be deprecated for any of the following reasons:
* An improved alternative API is available.
* Breaking changes to the API are expected in a future major release.

Deprecated features are subject to [semantic versioning][] rules.
Copy link
Copy Markdown
Member

@joyeecheung joyeecheung Mar 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this is the case for the undocumented features being deprecated.


Node.js uses four kinds of deprecations:

* Documentation-only
Expand Down Expand Up @@ -4679,6 +4681,7 @@ deprecated and will throw an error in a future version.
[legacy URL API]: url.md#legacy-url-api
[legacy `urlObject`]: url.md#legacy-urlobject
[permission model]: permissions.md#permission-model
[semantic versioning]: https://semver.org/
[static methods of `crypto.Certificate()`]: crypto.md#class-certificate
[subpath exports]: packages.md#subpath-exports
[subpath imports]: packages.md#subpath-imports
Expand Down
4 changes: 3 additions & 1 deletion doc/api/documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,9 @@ The stability indexes are as follows:
> we can know that this feature is ready to be marked as stable.
>
> Experimental features leave the experimental status typically either by
> graduating to stable, or are removed without a deprecation cycle.
> graduating to stable, or are removed without a deprecation cycle. In less
> common cases, if the feature has gotten large adoption in the ecosystem,
> they can also leave the experimental status by being deprecated.

<!-- separator -->

Expand Down
Loading