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

doc: document switchover from measured bytes to chars after setEncoding #13442

Closed
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
8 participants
@jessqt
Contributor

jessqt commented Jun 3, 2017

Checklist

Ref: #6798

This is documentation PR to denote the change of measurement against the highWaterMark in non-object streams after .setEncoding() is called. It changes from bytes to character.

Affected core subsystem(s)

doc

Show outdated Hide outdated doc/api/stream.md
Show outdated Hide outdated doc/api/stream.md
Show outdated Hide outdated doc/api/stream.md
Show outdated Hide outdated doc/api/stream.md
Show outdated Hide outdated doc/api/stream.md
@mscdex

This comment has been minimized.

Show comment
Hide comment
@mscdex

mscdex Jun 3, 2017

Contributor

Also, the first line of the commit message is too long.

Contributor

mscdex commented Jun 3, 2017

Also, the first line of the commit message is too long.

@jasnell

jasnell approved these changes Jun 4, 2017

@tniessen

This comment has been minimized.

Show comment
Hide comment
@tniessen

tniessen Aug 16, 2017

Member

@jessicaquynh This needs to be rebased, sorry for the delay.
@mscdex @vsemozhetbyt Could you PTAL?

Member

tniessen commented Aug 16, 2017

@jessicaquynh This needs to be rebased, sorry for the delay.
@mscdex @vsemozhetbyt Could you PTAL?

@BridgeAR

This comment has been minimized.

Show comment
Hide comment
@BridgeAR

BridgeAR Aug 28, 2017

Member

Ping @jessicaquynh this needs a rebase

Member

BridgeAR commented Aug 28, 2017

Ping @jessicaquynh this needs a rebase

@jessqt

This comment has been minimized.

Show comment
Hide comment
@jessqt

jessqt Aug 28, 2017

Contributor

@BridgeAR Sorry! Didn't realize that was on me. Thank you!

Contributor

jessqt commented Aug 28, 2017

@BridgeAR Sorry! Didn't realize that was on me. Thank you!

Show outdated Hide outdated doc/api/stream.md
Show outdated Hide outdated doc/api/stream.md
Show outdated Hide outdated doc/api/stream.md
Show outdated Hide outdated doc/api/stream.md
Show outdated Hide outdated doc/api/stream.md
@BridgeAR

LGTM with the comment addressed.

Show outdated Hide outdated doc/api/stream.md
doc: document switchover from measured bytes to chars after setEncoding
This commit documents and edge-case behavior in readable streams. It is
expected that non-object streams are measured in bytes against the
highWaterMark. However, it was discovered in issue #6798 that after calling
.setEncoding() on the stream, it will thereafter begin to measure the buffer's
length in characters.
@BridgeAR

This comment has been minimized.

Show comment
Hide comment
@BridgeAR

BridgeAR Sep 8, 2017

Member

Landed in 89f2074

@jessicaquynh thanks a lot for your contribution

Member

BridgeAR commented Sep 8, 2017

Landed in 89f2074

@jessicaquynh thanks a lot for your contribution

@BridgeAR BridgeAR closed this Sep 8, 2017

BridgeAR added a commit that referenced this pull request Sep 8, 2017

doc: document bytes to chars after setEncoding
This commit documents and edge-case behavior in readable streams.
It is expected that non-object streams are measured in bytes
against the highWaterMark. However, it was discovered in issue
thereafter begin to measure the buffer's length in characters.

PR-URL: #13442
Refs: #6798
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

MylesBorins added a commit that referenced this pull request Sep 10, 2017

doc: document bytes to chars after setEncoding
This commit documents and edge-case behavior in readable streams.
It is expected that non-object streams are measured in bytes
against the highWaterMark. However, it was discovered in issue
thereafter begin to measure the buffer's length in characters.

PR-URL: #13442
Refs: #6798
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

@MylesBorins MylesBorins referenced this pull request Sep 10, 2017

Merged

v8.5.0 proposal #15308

MylesBorins added a commit that referenced this pull request Sep 11, 2017

doc: document bytes to chars after setEncoding
This commit documents and edge-case behavior in readable streams.
It is expected that non-object streams are measured in bytes
against the highWaterMark. However, it was discovered in issue
thereafter begin to measure the buffer's length in characters.

PR-URL: #13442
Refs: #6798
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

MylesBorins added a commit that referenced this pull request Sep 12, 2017

doc: document bytes to chars after setEncoding
This commit documents and edge-case behavior in readable streams.
It is expected that non-object streams are measured in bytes
against the highWaterMark. However, it was discovered in issue
thereafter begin to measure the buffer's length in characters.

PR-URL: #13442
Refs: #6798
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

addaleax added a commit to addaleax/node that referenced this pull request Sep 13, 2017

doc: document bytes to chars after setEncoding
This commit documents and edge-case behavior in readable streams.
It is expected that non-object streams are measured in bytes
against the highWaterMark. However, it was discovered in issue
thereafter begin to measure the buffer's length in characters.

PR-URL: nodejs#13442
Refs: nodejs#6798
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

MylesBorins added a commit that referenced this pull request Sep 20, 2017

doc: document bytes to chars after setEncoding
This commit documents and edge-case behavior in readable streams.
It is expected that non-object streams are measured in bytes
against the highWaterMark. However, it was discovered in issue
thereafter begin to measure the buffer's length in characters.

PR-URL: #13442
Refs: #6798
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

@MylesBorins MylesBorins referenced this pull request Sep 20, 2017

Merged

v6.11.4 proposal #15506

MylesBorins added a commit that referenced this pull request Sep 21, 2017

doc: document bytes to chars after setEncoding
This commit documents and edge-case behavior in readable streams.
It is expected that non-object streams are measured in bytes
against the highWaterMark. However, it was discovered in issue
thereafter begin to measure the buffer's length in characters.

PR-URL: #13442
Refs: #6798
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>

MylesBorins added a commit that referenced this pull request Sep 26, 2017

doc: document bytes to chars after setEncoding
This commit documents and edge-case behavior in readable streams.
It is expected that non-object streams are measured in bytes
against the highWaterMark. However, it was discovered in issue
thereafter begin to measure the buffer's length in characters.

PR-URL: #13442
Refs: #6798
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment