doc: Update docs for writable streams default encoding #502
Conversation
This file contains 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
Setting the default encoding for a writable stream does not return a boolean (true if successful or false if not) as the docs indicate. Instead, if the operation is successful nothing is returned and the method throws an error when something goes wrong. This stems from a contribution that was tweaked but the docs were never updated accordingly.
recursivefunk
changed the title
rvagg
pushed a commit
that referenced
this pull request
Jan 27, 2015
Setting the default encoding for a writable stream does not return a boolean (true if successful or false if not) as the docs indicate. Instead, if the operation is successful nothing is returned and the method throws an error when something goes wrong. This stems from a contribution that was tweaked but the docs were never updated accordingly. PR-URL: #502 Reviewed-By: Rod Vagg <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Setting the default encoding for a writable stream does
not return a boolean (true if successful or false if not)
as the docs indicate. Instead, if the operation is successful
nothing is returned and the method throws an error when
something goes wrong.
This stems from a contribution that was tweaked but the
docs were never updated accordingly.