Update stream.md - fix issue in setEncoding method #11363

RickBullotta · 2017-02-14T01:51:51Z

Removed an incorrect reference to the use of setEncoding(null) as the proper way to handling binary streams or to disable encoding, and explained that the default encoding is "no encoding", and that this is the correct approach for dealing with binary data via Buffers.

Checklist

documentation is changed or added

Affected core subsystem(s)

Affects documentation only

Removed an incorrect reference to the use of setEncoding(null) as the proper way to handling binary streams or to disable encoding, and explained that the default encoding is "no encoding", and that this is the correct approach for dealing with binary data via Buffers.

mscdex · 2017-02-14T02:15:49Z

doc/api/stream.md

-The `readable.setEncoding()` method sets the default character encoding for
-data read from the Readable stream.
+The `readable.setEncoding()` method sets the character encoding for
+data read from the Readable stream. 


Trailing space should be removed.

mscdex · 2017-02-14T02:16:45Z

doc/api/stream.md


-Setting an encoding causes the stream data
+By default, no encoding is assigned and stream data will be returned as 
+Buffer objects.  Setting an encoding causes the stream data


Double space after the period should be a single space (IMHO and to match the surrounding text).

mscdex · 2017-02-14T02:17:11Z

doc/api/stream.md


-Setting an encoding causes the stream data
+By default, no encoding is assigned and stream data will be returned as 
+Buffer objects.  Setting an encoding causes the stream data
 to be returned as string of the specified encoding rather than as `Buffer`


Can you add an 'a' before 'string' here too?

and before `Buffer`

Can you add an 'a' before 'string' here too?

Went with strings and Buffers instead (to match the rest of the paragraph).

mscdex · 2017-02-14T02:18:10Z

The first line of the commit message should target the doc subsystem.

gibfahn · 2017-02-14T06:58:55Z

Probably worth adding Fixes: #11352 and Refs: #11316 lines to the commit message. With @mscdex's nit above, you could probably do this for the commit message:

 doc: don't suggest setEncoding for binary streams

Removed an incorrect reference to the use of setEncoding(null) as the proper
way to handling binary streams or to disable encoding, and explained that the
default encoding is "no encoding", and that this is the correct approach for
dealing with binary data via Buffers.

Fixes: https://github.com/nodejs/node/issues/11352
Refs: https://github.com/nodejs/node/issues/11316

cc/ @sam-github for review

cjihrig · 2017-02-14T14:49:37Z

doc/api/stream.md


-Setting an encoding causes the stream data
+By default, no encoding is assigned and stream data will be returned as 
+Buffer objects.  Setting an encoding causes the stream data


Can you format Buffer as inline code.

sam-github

LGTM, once @mscdex and @cjihrig 's comments have been addressed

mcollina

LGTM when the others nits are addressed.

mcollina · 2017-05-19T08:37:31Z

@RickBullotta would you mind addressing the relative nits?
Otherwise, may I land and address the nit while landing this?

RickBullotta · 2017-05-19T10:21:01Z

Have at it. The amount of nit picking turned me off to the whole process.

…

On May 19, 2017, at 4:38 AM, Matteo Collina ***@***.***> wrote: @RickBullotta would you mind addressing the relative nits? Otherwise, may I land and address the nit while landing this? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

gibfahn

Will fix nits on landing.

Will fix on landing.

gibfahn · 2017-05-19T12:05:25Z

Landed in 8476880

Removed an incorrect reference to the use of setEncoding(null) as the proper way to handling binary streams or to disable encoding, and explained that the default encoding is "no encoding", and that this is the correct approach for dealing with binary data via Buffers. PR-URL: #11363 Fixes: #11352 Refs: #11316 Reviewed-By: Sam Roberts <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>

gibfahn · 2017-05-19T12:10:16Z

Have at it. The amount of nit picking turned me off to the whole process.

@RickBullotta I'd be really interested to get more feedback from you on this. What would your ideal process be?

Questions:

If we had a doc linter that could catch the majority of these nits would you be more willing to fix them?
Do you think we're being too picky in general, and should just not worry about formatting?
Is the problem in the way the nits were raised?
Do you think collaborators should just fix everything on landing and not expect contributors to fix nits in PRs?

There's no right answer for these things, but we're always trying to improve our process, so feedback from people just starting to get involved with the project is very helpful.

Removed an incorrect reference to the use of setEncoding(null) as the proper way to handling binary streams or to disable encoding, and explained that the default encoding is "no encoding", and that this is the correct approach for dealing with binary data via Buffers. PR-URL: nodejs#11363 Fixes: nodejs#11352 Refs: nodejs#11316 Reviewed-By: Sam Roberts <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>

RickBullotta · 2017-05-19T16:57:49Z

I think it would be more effective and efficient when proposing minor changes on documentation submissions to simply have those collaborators with proposed corrections make the corrections themselves…

MylesBorins · 2017-07-17T14:47:52Z

is this applicable for v6.x?

mcollina · 2017-07-17T15:48:17Z

@MylesBorins yes you can backport.

Removed an incorrect reference to the use of setEncoding(null) as the proper way to handling binary streams or to disable encoding, and explained that the default encoding is "no encoding", and that this is the correct approach for dealing with binary data via Buffers. PR-URL: #11363 Fixes: #11352 Refs: #11316 Reviewed-By: Sam Roberts <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>

nodejs-github-bot added doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem. labels Feb 14, 2017

mscdex reviewed Feb 14, 2017

View reviewed changes

gibfahn requested a review from sam-github February 14, 2017 06:59

cjihrig previously requested changes Feb 14, 2017

View reviewed changes

sam-github approved these changes Feb 16, 2017

View reviewed changes

mcollina approved these changes Mar 3, 2017

View reviewed changes

refack force-pushed the master branch from 16073c0 to fbe946b Compare April 14, 2017 04:11

gibfahn self-assigned this May 19, 2017

gibfahn approved these changes May 19, 2017

View reviewed changes

gibfahn closed this May 19, 2017

jasnell mentioned this pull request May 28, 2017

8.0.0 Release Proposal #12220

Closed

gibfahn mentioned this pull request Jun 15, 2017

Auditing for 6.11.1 nodejs/Release#230

Closed

3 tasks

MylesBorins added the lts-watch-v6.x label Jul 17, 2017

MylesBorins added land-on-v6.x and removed lts-watch-v6.x labels Jul 17, 2017

MylesBorins mentioned this pull request Jul 18, 2017

v6.11.2 proposal #14356

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update stream.md - fix issue in setEncoding method #11363

Update stream.md - fix issue in setEncoding method #11363

RickBullotta commented Feb 14, 2017

mscdex Feb 14, 2017

mscdex Feb 14, 2017

mscdex Feb 14, 2017

mscdex Feb 14, 2017

gibfahn May 19, 2017

mscdex commented Feb 14, 2017

gibfahn commented Feb 14, 2017 •

edited

Loading

cjihrig Feb 14, 2017

sam-github left a comment

mcollina left a comment

mcollina commented May 19, 2017

RickBullotta commented May 19, 2017 via email

gibfahn left a comment

gibfahn commented May 19, 2017

gibfahn commented May 19, 2017

RickBullotta commented May 19, 2017 via email

MylesBorins commented Jul 17, 2017

mcollina commented Jul 17, 2017

Update stream.md - fix issue in setEncoding method #11363

Update stream.md - fix issue in setEncoding method #11363

Conversation

RickBullotta commented Feb 14, 2017

Checklist

Affected core subsystem(s)

mscdex Feb 14, 2017

Choose a reason for hiding this comment

mscdex Feb 14, 2017

Choose a reason for hiding this comment

mscdex Feb 14, 2017

Choose a reason for hiding this comment

mscdex Feb 14, 2017

Choose a reason for hiding this comment

gibfahn May 19, 2017

Choose a reason for hiding this comment

mscdex commented Feb 14, 2017

gibfahn commented Feb 14, 2017 • edited Loading

cjihrig Feb 14, 2017

Choose a reason for hiding this comment

sam-github left a comment

Choose a reason for hiding this comment

mcollina left a comment

Choose a reason for hiding this comment

mcollina commented May 19, 2017

RickBullotta commented May 19, 2017 via email

gibfahn left a comment

Choose a reason for hiding this comment

gibfahn commented May 19, 2017

gibfahn commented May 19, 2017

Questions:

RickBullotta commented May 19, 2017 via email

MylesBorins commented Jul 17, 2017

mcollina commented Jul 17, 2017

gibfahn commented Feb 14, 2017 •

edited

Loading