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

docs: remove http streams from the list of writeables #30217

Closed
wants to merge 1 commit into from

Conversation

just-boris
Copy link

@just-boris just-boris commented Nov 2, 2019

The documentation lists HTTP server response and HTTP client request as writable streams. However, in fact, they are not, which confuses users. Example in this twitter thread: https://mobile.twitter.com/getify/status/1190456439996854273

I have checked other examples, they all extend stream.Writable, so they are fine to stay in the list.

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

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem. labels Nov 2, 2019
@addaleax
Copy link
Member

@just-boris So … while this is technically true, removing them is not helpful imo, because they largely implement the Writable interface, even without inheriting from it.

The issue referenced in the tweet has been addressed in #29053.

If you do want to fix the documentation here, I’d prefer adding notes that these streams don’t strictly inherit from Writable.

@just-boris
Copy link
Author

If the original issue has been solved, I'd rather close this PR

@just-boris just-boris closed this Dec 1, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants