Reword stream docs to clarify that decodeStrings encodes strings #25468
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
nodejs-github-bot
added
doc
I was implementing a Writable stream and misunderstood `decodeStrings` to mean 'will decode `Buffer`s into `string`s before calling `_write`'. This change adds a little more detail to the description of `decodeStrings` to clarify its effect on a Writable stream & what gets passed to `_write`. Changing the name of the option to `encodeStrings` would make it much easier to understand, but the name was chosen in 2012 and the option used in many projects (22k mentions of 'decodeStringsr in JS projects in GitHub). Deprecating the old name & rolling out a replacement is beyond my capabilities as a first-time contributor. Fixes: nodejs#25464
dgholz
force-pushed
the
refactor-decodeStrings-docs
branch
from
1dcd23f to
2aaa4d2
Compare
|
whoops, missed the bit in the contribution guide about prefixing the commit message with the subsystem |
addaleax
approved these changes
Jan 13, 2019
doc/api/stream.md
Outdated
| * `chunk` {Buffer|string|any} The `Buffer` to be written, converted from the | ||
| `string` passed to [`stream.write()`][stream-write]. If the stream's | ||
| `decodeStrings` option is `false` or the stream is operating in object mode, | ||
| chunk will not be converted & will be whatever was passed to |
There was a problem hiding this comment.
Suggested change
| chunk will not be converted & will be whatever was passed to | |
| the chunk will not be converted & will be whatever was passed to |
doc/api/stream.md
Outdated
| * `chunk` {Buffer|string|any} The `Buffer` to be transformed, converted from | ||
| the `string` passed to [`stream.write()`][stream-write]. If the stream's | ||
| `decodeStrings` option is `false` or the stream is operating in object mode, | ||
| chunk will not be converted & will be whatever was passed to |
There was a problem hiding this comment.
Suggested change
| chunk will not be converted & will be whatever was passed to | |
| the chunk will not be converted & will be whatever was passed to |
|
Landed in fac11b0 |
addaleax
pushed a commit
that referenced
this pull request
Jan 23, 2019
I was implementing a Writable stream and misunderstood `decodeStrings` to mean 'will decode `Buffer`s into `string`s before calling `_write`'. This change adds a little more detail to the description of `decodeStrings` to clarify its effect on a Writable stream & what gets passed to `_write`. Changing the name of the option to `encodeStrings` would make it much easier to understand, but the name was chosen in 2012 and the option used in many projects (22k mentions of 'decodeStringsr in JS projects in GitHub). Deprecating the old name & rolling out a replacement is beyond my capabilities as a first-time contributor. PR-URL: #25468 Fixes: #25464 Reviewed-By: Anna Henningsen <anna@addaleax.net>
Merged
BethGriggs
pushed a commit
that referenced
this pull request
Apr 29, 2019
I was implementing a Writable stream and misunderstood `decodeStrings` to mean 'will decode `Buffer`s into `string`s before calling `_write`'. This change adds a little more detail to the description of `decodeStrings` to clarify its effect on a Writable stream & what gets passed to `_write`. Changing the name of the option to `encodeStrings` would make it much easier to understand, but the name was chosen in 2012 and the option used in many projects (22k mentions of 'decodeStringsr in JS projects in GitHub). Deprecating the old name & rolling out a replacement is beyond my capabilities as a first-time contributor. PR-URL: #25468 Fixes: #25464 Reviewed-By: Anna Henningsen <anna@addaleax.net>
Merged
BethGriggs
pushed a commit
that referenced
this pull request
May 10, 2019
I was implementing a Writable stream and misunderstood `decodeStrings` to mean 'will decode `Buffer`s into `string`s before calling `_write`'. This change adds a little more detail to the description of `decodeStrings` to clarify its effect on a Writable stream & what gets passed to `_write`. Changing the name of the option to `encodeStrings` would make it much easier to understand, but the name was chosen in 2012 and the option used in many projects (22k mentions of 'decodeStringsr in JS projects in GitHub). Deprecating the old name & rolling out a replacement is beyond my capabilities as a first-time contributor. PR-URL: #25468 Fixes: #25464 Reviewed-By: Anna Henningsen <anna@addaleax.net>
MylesBorins
pushed a commit
that referenced
this pull request
May 16, 2019
I was implementing a Writable stream and misunderstood `decodeStrings` to mean 'will decode `Buffer`s into `string`s before calling `_write`'. This change adds a little more detail to the description of `decodeStrings` to clarify its effect on a Writable stream & what gets passed to `_write`. Changing the name of the option to `encodeStrings` would make it much easier to understand, but the name was chosen in 2012 and the option used in many projects (22k mentions of 'decodeStringsr in JS projects in GitHub). Deprecating the old name & rolling out a replacement is beyond my capabilities as a first-time contributor. PR-URL: #25468 Fixes: #25464 Reviewed-By: Anna Henningsen <anna@addaleax.net>
This was referenced May 29, 2019
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.
I was implementing a Writable stream and misunderstood
decodeStringsto mean 'will decode
Buffers intostrings before calling_write'.This change adds a little more detail to the description of
decodeStringsto clarify its effect on a Writable stream & what getspassed to
_write.Changing the name of the option to
encodeStringswould make it mucheasier to understand, but the name was chosen in 2012 and the option
used in many projects (22k mentions of 'decodeStringsr in JS projects in
GitHub). Deprecating the old name & rolling out a replacement is beyond
my capabilities as a first-time contributor.
Fixes: #25464
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes