Skip to content
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.

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

doc: document non-node_modules-only runtime deprecation #50748

Merged
merged 4 commits into from
Nov 28, 2023

Conversation

joyeecheung
Copy link
Member

We already have this special kind of runtime deprecation for Buffer constructors which does not fit into the original description of runtiem deprecations. Document this kind of deprecation separately.

We already have this special kind of runtime deprecation for
Buffer constructors which does not fit into the original
description of runtiem deprecations. Document this kind of
deprecation separately.
@nodejs-github-bot nodejs-github-bot added deprecations Issues and PRs related to deprecations. doc Issues and PRs related to the documentations. labels Nov 15, 2023
@joyeecheung
Copy link
Member Author

cc @nodejs/tsc

doc/api/deprecations.md Outdated Show resolved Hide resolved
doc/api/deprecations.md Outdated Show resolved Hide resolved
doc/api/deprecations.md Outdated Show resolved Hide resolved
Copy link
Member

@tniessen tniessen left a comment

Choose a reason for hiding this comment

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

We only have one such case and I am not sure if it's a pattern we want to extend upon, so I am also not sure if further distinction into four levels makes sense.

@GeoffreyBooth
Copy link
Member

We only have one such case and I am not sure if it's a pattern we want to extend upon, so I am also not sure if further distinction into four levels makes sense.

I didn't even know this possibility existed. There are many modules features where we would want such a "my code only" warning.

@joyeecheung
Copy link
Member Author

joyeecheung commented Nov 17, 2023

We only have one such case and I am not sure if it's a pattern we want to extend upon, so I am also not sure if further distinction into four levels makes sense.

The reason why we had this case was because Buffer constructor was too widely used so that we had many complaints from users after emitting the warnings by default and it encouraged disabling warnings (especially for CLIs that spawn child processes). I am fairly certain that this would happen again soon, looking at our recent deprecation discussions.

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

lgtm

@lpinca
Copy link
Member

lpinca commented Nov 18, 2023

There is a typo in commit message. runtiem -> runtime.

doc/api/deprecations.md Outdated Show resolved Hide resolved
@joyeecheung joyeecheung added commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. labels Nov 28, 2023
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Nov 28, 2023
@nodejs-github-bot nodejs-github-bot merged commit 3ffe2e8 into nodejs:main Nov 28, 2023
19 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in 3ffe2e8

targos pushed a commit that referenced this pull request Dec 4, 2023
We already have this special kind of runtime deprecation for
Buffer constructors which does not fit into the original
description of runtiem deprecations. Document this kind of
deprecation separately.

PR-URL: #50748
Reviewed-By: Geoffrey Booth <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
@targos targos mentioned this pull request Dec 4, 2023
richardlau pushed a commit that referenced this pull request Mar 25, 2024
We already have this special kind of runtime deprecation for
Buffer constructors which does not fit into the original
description of runtiem deprecations. Document this kind of
deprecation separately.

PR-URL: #50748
Reviewed-By: Geoffrey Booth <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Benjamin Gruenbaum <[email protected]>
@richardlau richardlau mentioned this pull request Mar 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. deprecations Issues and PRs related to deprecations. doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

9 participants