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

stream: update comment to indicate unused API #32808

Closed
wants to merge 1 commit into from

Conversation

ronag
Copy link
Member

@ronag ronag commented Apr 13, 2020

destroy w/ callback was previously used by node
core. This is no longer the case and the
comments should reflect this to avoid confusion.

We briefly discussed making this API public. I'm still good with that but it would require the if (destroyed) branch to use stream.finished. Though if and until then this PR updates the comments to reflect the current state of things. The use of destroy(err, cb) has been refactored away in recent PRs.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

destroy w/ callback was previously used by node
core. This is no longer the case and the
comments should reflect this to avoid confusion.
@ronag
Copy link
Member Author

ronag commented Apr 13, 2020

My mistake, there was one last use case I missed. #32809

@ronag ronag added the stream Issues and PRs related to the stream subsystem. label Apr 13, 2020
@lpinca
Copy link
Member

lpinca commented Apr 13, 2020

👍 for deprecating it and then removing it.

@ronag ronag added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Apr 14, 2020
@ronag ronag requested review from AndreasMadsen and mcollina and removed request for AndreasMadsen April 14, 2020 19:37
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

I think we could even remove it in a semver-major change.

@nodejs-github-bot
Copy link
Collaborator

ronag added a commit to nxtedition/node that referenced this pull request Apr 15, 2020
destroy(err, cb) was an undocumented API which
was previously used internally by core modules.
However, this is no longer the case and it should
be possible to safely remove this.

Refs: nodejs#32808
@nodejs-github-bot
Copy link
Collaborator

@nodejs-github-bot
Copy link
Collaborator

ronag added a commit that referenced this pull request Apr 16, 2020
destroy w/ callback was previously used by node
core. This is no longer the case and the
comments should reflect this to avoid confusion.

PR-URL: #32808
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
@ronag
Copy link
Member Author

ronag commented Apr 16, 2020

Landed in 15cc2b6

@ronag ronag closed this Apr 16, 2020
MylesBorins pushed a commit that referenced this pull request Apr 17, 2020
destroy w/ callback was previously used by node
core. This is no longer the case and the
comments should reflect this to avoid confusion.

PR-URL: #32808
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Matteo Collina <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. stream Issues and PRs related to the stream subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants