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.

Sign up for GitHub

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

Jump to bottom

stream: update doc for new default high water mark #53494

Merged
merged 3 commits into from
Jun 20, 2024
Merged

stream: update doc for new default high water mark #53494

merged 3 commits into from
Jun 20, 2024

Conversation

jsk95
Copy link
Contributor

@jsk95 jsk95 commented Jun 17, 2024

New value for stream.getDefaultHighWaterMark(objectMode) update was missed in the previous PR.
#52037

Updating the value.

@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 Jun 17, 2024
@RedYetiDev
Copy link
Member

Thanks for submitting this change. Before this can be merged, the first commit message must be all lowercase to abide by the guidelines

@jsk95 jsk95 changed the title stream: Update doc for new default high water mark stream: update doc for new default high water mark Jun 18, 2024
MoLow
MoLow previously approved these changes Jun 18, 2024
View reviewed changes
MoLow
MoLow reviewed Jun 18, 2024
View reviewed changes
doc/api/stream.md Outdated Show resolved Hide resolved
@MoLow MoLow requested a review from ronag June 18, 2024 06:15
@MoLow MoLow dismissed their stale review June 18, 2024 06:16

some wrong change

@jakecastelli
Copy link
Member

jakecastelli commented Jun 18, 2024 •
edited
Loading

I think I made a wrong suggestion. It is not 16 KiB, 16 was actually correct. Sorry! see detail for getDefaultHighWaterMark function here (on current main branch)

@jsk95
Copy link
Contributor Author

jsk95 commented Jun 20, 2024

Thanks! Please merge whenever suits 👍

@marco-ippolito marco-ippolito added author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue Add this label to land a pull request using GitHub Actions. labels Jun 20, 2024
@nodejs-github-bot nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Jun 20, 2024
@nodejs-github-bot
Copy link
Collaborator

Commit Queue failed
- Loading data for nodejs/node/pull/53494
✔  Done loading data for nodejs/node/pull/53494
----------------------------------- PR info ------------------------------------
Title      stream: update doc for new default high water mark (#53494)
   ⚠  Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch     jsk95:patch-1 -> nodejs:main
Labels     doc, stream, author ready
Commits    3
 - stream: update outdated highwatermark doc
 - stream: update doc for new default high water mark
 - stream: update outdated highwatermark doc
Committers 2
 - Jay Kim 
 - GitHub 
PR-URL: https://github.com/nodejs/node/pull/53494
Reviewed-By: Moshe Atlow 
Reviewed-By: Marco Ippolito 
Reviewed-By: Luigi Pinca 
Reviewed-By: Trivikram Kamat 
Reviewed-By: Robert Nagy 
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/53494
Reviewed-By: Moshe Atlow 
Reviewed-By: Marco Ippolito 
Reviewed-By: Luigi Pinca 
Reviewed-By: Trivikram Kamat 
Reviewed-By: Robert Nagy 
--------------------------------------------------------------------------------
   ℹ  This PR was created on Mon, 17 Jun 2024 22:30:04 GMT
   ✔  Approvals: 5
   ✔  - Moshe Atlow (@MoLow) (TSC): https://github.com/nodejs/node/pull/53494#pullrequestreview-2124683767
   ✔  - Marco Ippolito (@marco-ippolito) (TSC): https://github.com/nodejs/node/pull/53494#pullrequestreview-2124771913
   ✔  - Luigi Pinca (@lpinca): https://github.com/nodejs/node/pull/53494#pullrequestreview-2126027541
   ✔  - Trivikram Kamat (@trivikr): https://github.com/nodejs/node/pull/53494#pullrequestreview-2129323141
   ✔  - Robert Nagy (@ronag) (TSC): https://github.com/nodejs/node/pull/53494#pullrequestreview-2129414408
   ✔  Last GitHub CI successful
   ℹ  Green GitHub CI is sufficient
--------------------------------------------------------------------------------
   ✔  No git cherry-pick in progress
   ✔  No git am in progress
   ✔  No git rebase in progress
--------------------------------------------------------------------------------
- Bringing origin/main up to date...
From https://github.com/nodejs/node
 * branch                  main       -> FETCH_HEAD
✔  origin/main is now up-to-date
- Downloading patch for 53494
From https://github.com/nodejs/node
 * branch                  refs/pull/53494/merge -> FETCH_HEAD
✔  Fetched commits as 399eb338f18a..222ea9835c4d
--------------------------------------------------------------------------------
[main 670aaccf69] stream: update outdated highwatermark doc
 Author: Jay Kim 
 Date: Tue Jun 18 15:04:52 2024 +1200
 1 file changed, 1 insertion(+), 1 deletion(-)
[main 15c4458804] stream: update doc for new default high water mark
 Author: Jay Kim <[email protected]>
 Date: Tue Jun 18 18:09:46 2024 +1200
 1 file changed, 1 insertion(+), 1 deletion(-)
[main 6b2c590782] stream: update outdated highwatermark doc
 Author: Jay Kim 
 Date: Tue Jun 18 18:39:43 2024 +1200
 1 file changed, 1 insertion(+), 1 deletion(-)
   ✔  Patches applied
There are 3 commits in the PR. Attempting autorebase.
Rebasing (2/6)

Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

stream: update outdated highwatermark doc


PR-URL: #53494

Reviewed-By: Moshe Atlow [email protected]

Reviewed-By: Marco Ippolito [email protected]

Reviewed-By: Luigi Pinca [email protected]

Reviewed-By: Trivikram Kamat [email protected]

Reviewed-By: Robert Nagy [email protected]


[detached HEAD 0ee3061e39] stream: update outdated highwatermark doc

Author: Jay Kim [email protected]

Date: Tue Jun 18 15:04:52 2024 +1200

1 file changed, 1 insertion(+), 1 deletion(-)

Rebasing (3/6)

Rebasing (4/6)


Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

stream: update doc for new default high water mark


Co-authored-by: jakecastelli [email protected]

PR-URL: #53494

Reviewed-By: Moshe Atlow [email protected]

Reviewed-By: Marco Ippolito [email protected]

Reviewed-By: Luigi Pinca [email protected]

Reviewed-By: Trivikram Kamat [email protected]

Reviewed-By: Robert Nagy [email protected]


[detached HEAD a406f6f8bf] stream: update doc for new default high water mark

Author: Jay Kim [email protected]

Date: Tue Jun 18 18:09:46 2024 +1200

1 file changed, 1 insertion(+), 1 deletion(-)

Rebasing (5/6)

Rebasing (6/6)


Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

stream: update outdated highwatermark doc


PR-URL: #53494

Reviewed-By: Moshe Atlow [email protected]

Reviewed-By: Marco Ippolito [email protected]

Reviewed-By: Luigi Pinca [email protected]

Reviewed-By: Trivikram Kamat [email protected]

Reviewed-By: Robert Nagy [email protected]


[detached HEAD 6559432783] stream: update outdated highwatermark doc

Author: Jay Kim [email protected]

Date: Tue Jun 18 18:39:43 2024 +1200

1 file changed, 1 insertion(+), 1 deletion(-)


Successfully rebased and updated refs/heads/main.


ℹ  Add commit-queue-squash label to land the PR as one commit, or commit-queue-rebase to land as separate commits.
https://github.com/nodejs/node/actions/runs/9593864985

@marco-ippolito marco-ippolito added commit-queue-rebase Add this label to allow the Commit Queue to land a PR in several commits. commit-queue Add this label to land a pull request using GitHub Actions. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels Jun 20, 2024
@nodejs-github-bot nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Jun 20, 2024
@nodejs-github-bot
Copy link
Collaborator

Commit Queue failed
- Loading data for nodejs/node/pull/53494
✔  Done loading data for nodejs/node/pull/53494
----------------------------------- PR info ------------------------------------
Title      stream: update doc for new default high water mark (#53494)
   ⚠  Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch     jsk95:patch-1 -> nodejs:main
Labels     doc, stream, author ready, commit-queue-rebase
Commits    3
 - stream: update outdated highwatermark doc
 - stream: update doc for new default high water mark
 - stream: update outdated highwatermark doc
Committers 2
 - Jay Kim 
 - GitHub 
PR-URL: https://github.com/nodejs/node/pull/53494
Reviewed-By: Moshe Atlow 
Reviewed-By: Marco Ippolito 
Reviewed-By: Luigi Pinca 
Reviewed-By: Trivikram Kamat 
Reviewed-By: Robert Nagy 
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/53494
Reviewed-By: Moshe Atlow 
Reviewed-By: Marco Ippolito 
Reviewed-By: Luigi Pinca 
Reviewed-By: Trivikram Kamat 
Reviewed-By: Robert Nagy 
--------------------------------------------------------------------------------
   ℹ  This PR was created on Mon, 17 Jun 2024 22:30:04 GMT
   ✔  Approvals: 5
   ✔  - Moshe Atlow (@MoLow) (TSC): https://github.com/nodejs/node/pull/53494#pullrequestreview-2124683767
   ✔  - Marco Ippolito (@marco-ippolito) (TSC): https://github.com/nodejs/node/pull/53494#pullrequestreview-2124771913
   ✔  - Luigi Pinca (@lpinca): https://github.com/nodejs/node/pull/53494#pullrequestreview-2126027541
   ✔  - Trivikram Kamat (@trivikr): https://github.com/nodejs/node/pull/53494#pullrequestreview-2129323141
   ✔  - Robert Nagy (@ronag) (TSC): https://github.com/nodejs/node/pull/53494#pullrequestreview-2129414408
   ✔  Last GitHub CI successful
   ℹ  Green GitHub CI is sufficient
--------------------------------------------------------------------------------
   ✔  No git cherry-pick in progress
   ✔  No git am in progress
   ✔  No git rebase in progress
--------------------------------------------------------------------------------
- Bringing origin/main up to date...
From https://github.com/nodejs/node
 * branch                  main       -> FETCH_HEAD
✔  origin/main is now up-to-date
- Downloading patch for 53494
From https://github.com/nodejs/node
 * branch                  refs/pull/53494/merge -> FETCH_HEAD
✔  Fetched commits as 399eb338f18a..222ea9835c4d
--------------------------------------------------------------------------------
[main 193d49f831] stream: update outdated highwatermark doc
 Author: Jay Kim 
 Date: Tue Jun 18 15:04:52 2024 +1200
 1 file changed, 1 insertion(+), 1 deletion(-)
[main c5477b4ef0] stream: update doc for new default high water mark
 Author: Jay Kim <[email protected]>
 Date: Tue Jun 18 18:09:46 2024 +1200
 1 file changed, 1 insertion(+), 1 deletion(-)
[main eff494e913] stream: update outdated highwatermark doc
 Author: Jay Kim 
 Date: Tue Jun 18 18:39:43 2024 +1200
 1 file changed, 1 insertion(+), 1 deletion(-)
   ✔  Patches applied
There are 3 commits in the PR. Attempting autorebase.
Rebasing (2/6)

Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

stream: update outdated highwatermark doc


PR-URL: #53494

Reviewed-By: Moshe Atlow [email protected]

Reviewed-By: Marco Ippolito [email protected]

Reviewed-By: Luigi Pinca [email protected]

Reviewed-By: Trivikram Kamat [email protected]

Reviewed-By: Robert Nagy [email protected]


[detached HEAD 8d93652dc8] stream: update outdated highwatermark doc

Author: Jay Kim [email protected]

Date: Tue Jun 18 15:04:52 2024 +1200

1 file changed, 1 insertion(+), 1 deletion(-)

Rebasing (3/6)

Rebasing (4/6)


Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

stream: update doc for new default high water mark


Co-authored-by: jakecastelli [email protected]

PR-URL: #53494

Reviewed-By: Moshe Atlow [email protected]

Reviewed-By: Marco Ippolito [email protected]

Reviewed-By: Luigi Pinca [email protected]

Reviewed-By: Trivikram Kamat [email protected]

Reviewed-By: Robert Nagy [email protected]


[detached HEAD f8e0673b56] stream: update doc for new default high water mark

Author: Jay Kim [email protected]

Date: Tue Jun 18 18:09:46 2024 +1200

1 file changed, 1 insertion(+), 1 deletion(-)

Rebasing (5/6)

Rebasing (6/6)


Executing: git node land --amend --yes

--------------------------------- New Message ----------------------------------

stream: update outdated highwatermark doc


PR-URL: #53494

Reviewed-By: Moshe Atlow [email protected]

Reviewed-By: Marco Ippolito [email protected]

Reviewed-By: Luigi Pinca [email protected]

Reviewed-By: Trivikram Kamat [email protected]

Reviewed-By: Robert Nagy [email protected]


[detached HEAD 207f3c703a] stream: update outdated highwatermark doc

Author: Jay Kim [email protected]

Date: Tue Jun 18 18:39:43 2024 +1200

1 file changed, 1 insertion(+), 1 deletion(-)


Successfully rebased and updated refs/heads/main.


✔  8d93652dc8dbd630f6bff5fc4ebc8384a6ce7b88

✔  0:0      no Co-authored-by metadata                co-authored-by-is-trailer

✔  0:0      skipping fixes-url                        fixes-url

✔  0:0      blank line after title                    line-after-title

✔  0:0      line-lengths are valid                    line-length

✔  0:0      metadata is at end of message             metadata-end

✔  1:8      PR-URL is valid.                          pr-url

✔  0:0      reviewers are valid                       reviewers

✔  0:0      valid subsystems                          subsystem

✔  0:0      Title is formatted correctly.             title-format

✔  0:0      Title is <= 50 columns.                   title-length

✖  f8e0673b56807cfe7acba65df540651073ba99fb

✔  0:0      Co-authored-by is a trailer               co-authored-by-is-trailer

✔  0:0      skipping fixes-url                        fixes-url

✔  0:0      blank line after title                    line-after-title

✖  1:72     Line should be <= 72 columns.             line-length

✔  0:0      metadata is at end of message             metadata-end

✔  2:8      PR-URL is valid.                          pr-url

✔  0:0      reviewers are valid                       reviewers

✔  0:0      valid subsystems                          subsystem

✔  0:0      Title is formatted correctly.             title-format

✔  0:0      Title is <= 50 columns.                   title-length

✔  207f3c703aa8d478fd34c311c1b00ad09ba398ed

✔  0:0      no Co-authored-by metadata                co-authored-by-is-trailer

✔  0:0      skipping fixes-url                        fixes-url

✔  0:0      blank line after title                    line-after-title

✔  0:0      line-lengths are valid                    line-length

✔  0:0      metadata is at end of message             metadata-end

✔  1:8      PR-URL is valid.                          pr-url

✔  0:0      reviewers are valid                       reviewers

✔  0:0      valid subsystems                          subsystem

✔  0:0      Title is formatted correctly.             title-format

✔  0:0      Title is <= 50 columns.                   title-length


ℹ  Please fix the commit message and try again.

Please manually ammend the commit message, by running

git commit --amend

Once commit message is fixed, finish the landing command running

git node land --continue
https://github.com/nodejs/node/actions/runs/9594048048

@MoLow MoLow added commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. commit-queue-rebase Add this label to allow the Commit Queue to land a PR in several commits. labels Jun 20, 2024
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Jun 20, 2024
@nodejs-github-bot nodejs-github-bot merged commit b952ee1 into nodejs:main Jun 20, 2024
37 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in b952ee1

targos pushed a commit that referenced this pull request Jun 20, 2024
@jsk95 @targos
stream: update outdated highwatermark doc
8b87709 
PR-URL: #53494
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Robert Nagy <[email protected]>
EliphazBouye pushed a commit to EliphazBouye/node that referenced this pull request Jun 20, 2024
@jsk95 @EliphazBouye
stream: update outdated highwatermark doc
2e6905d 
PR-URL: nodejs#53494
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Robert Nagy <[email protected]>
bmeck pushed a commit to bmeck/node that referenced this pull request Jun 22, 2024
@jsk95 @bmeck
stream: update outdated highwatermark doc
fd46e59 
PR-URL: nodejs#53494
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Robert Nagy <[email protected]>
@targos targos mentioned this pull request Jun 25, 2024
Merged
@Karliz24 Karliz24 mentioned this pull request Jul 9, 2024
Open
marco-ippolito pushed a commit that referenced this pull request Jul 19, 2024
@jsk95 @marco-ippolito
stream: update outdated highwatermark doc
72f4ca2 
PR-URL: #53494
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Robert Nagy <[email protected]>
marco-ippolito pushed a commit that referenced this pull request Jul 19, 2024
@jsk95 @marco-ippolito
stream: update outdated highwatermark doc
e092c62 
PR-URL: #53494
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
Reviewed-By: Luigi Pinca <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Robert Nagy <[email protected]>
@marco-ippolito marco-ippolito mentioned this pull request Jul 19, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jakecastelli jakecastelli jakecastelli left review comments

@marco-ippolito marco-ippolito marco-ippolito approved these changes

@trivikr trivikr trivikr approved these changes

@MoLow MoLow MoLow approved these changes

@ronag ronag ronag approved these changes

@lpinca lpinca lpinca approved these changes

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. doc Issues and PRs related to the documentations. stream Issues and PRs related to the stream subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
10 participants
@jsk95 @RedYetiDev @jakecastelli @nodejs-github-bot @lpinca @ronag @MoLow @trivikr @marco-ippolito @jkim10atlas