Skip to content
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 watermark string behavior #52842

Merged
merged 1 commit into from
May 10, 2024
Merged

doc: document watermark string behavior #52842

merged 1 commit into from
May 10, 2024

Conversation

benjamingr
Copy link
Member

Bikeshedding/doc suggestions (should we edit it in other places like (readableLength/writableLength?) welcome

ping @lpinca @nodejs/streams


Documents that we calculate the highWaterMark value of streams operating on strings using the number of UTF-16 code units.

Fixes: #52818

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem. labels May 5, 2024
@lpinca
Copy link
Member

lpinca commented May 5, 2024

I'm not sure if the "but not decoding" bit is sufficient, it might be a bit too generic for someone not familiar with the implementation, but I can't think of anything better to suggest.

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

Documents that we calculate the highWaterMark value
of streams operating on strings using the number of
UTF-16 code units.

Fixes: #52818
@RedYetiDev RedYetiDev added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label May 7, 2024
@RedYetiDev
Copy link
Member

(3[+1] approving reviews; no failed tests)

@aduh95 aduh95 merged commit 761d2ce into main May 10, 2024
17 checks passed
@aduh95 aduh95 deleted the stream-string-length branch May 10, 2024 17:58
@aduh95
Copy link
Contributor

aduh95 commented May 10, 2024

Landed in 761d2ce

targos pushed a commit that referenced this pull request May 11, 2024
Documents that we calculate the highWaterMark value
of streams operating on strings using the number of
UTF-16 code units.

Fixes: #52818
PR-URL: #52842
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
lukins-cz pushed a commit to lukins-cz/OS-Aplet-node that referenced this pull request Jun 1, 2024
Documents that we calculate the highWaterMark value
of streams operating on strings using the number of
UTF-16 code units.

Fixes: nodejs#52818
PR-URL: nodejs#52842
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Writable doesn't correctly count size of strings
8 participants