docs: remove http streams from the list of writeables - #30217
Closed
just-boris wants to merge 1 commit into
Closed
Conversation
Copy link
Copy Markdown
Sorry, something went wrong.
Copy link
Copy Markdown
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. |
Sorry, something went wrong.
Copy link
Copy Markdown
Author
|
If the original issue has been solved, I'd rather close this PR |
Sorry, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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