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: explicitly document highWaterMark option #17049

Closed
wants to merge 1 commit into
base: master
from

Conversation

Projects
None yet
6 participants
@eps1lon
Contributor

eps1lon commented Nov 15, 2017

highWaterMark is currently only implicityl documented in a separate paragraph. This PR add this property and its default value to the argument documentation.

The value is set in lib/fs.js#L1990.

Should we add an additional note about what highWaterMark does or is the link to ReadStream enough?

Checklist
Affected core subsystem(s)

doc

@lpinca

lpinca approved these changes Nov 15, 2017

addaleax added a commit to addaleax/node that referenced this pull request Nov 18, 2017

doc: explicitly document highWaterMark option
PR-URL: nodejs#17049
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
@addaleax

This comment has been minimized.

Show comment
Hide comment
@addaleax

addaleax Nov 18, 2017

Member

Landed in 2c0acc0, thanks for the PR! 🎉

Member

addaleax commented Nov 18, 2017

Landed in 2c0acc0, thanks for the PR! 🎉

@addaleax addaleax closed this Nov 18, 2017

addaleax added a commit that referenced this pull request Nov 18, 2017

doc: explicitly document highWaterMark option
PR-URL: #17049
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

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

doc: explicitly document highWaterMark option
PR-URL: #17049
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

@MylesBorins MylesBorins referenced this pull request Dec 12, 2017

Merged

v9.3.0 proposal #17631

MylesBorins added a commit that referenced this pull request Dec 19, 2017

doc: explicitly document highWaterMark option
PR-URL: #17049
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

gibfahn added a commit that referenced this pull request Dec 19, 2017

doc: explicitly document highWaterMark option
PR-URL: #17049
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

@gibfahn gibfahn referenced this pull request Dec 20, 2017

Closed

v8.9.4 proposal #17772

gibfahn added a commit that referenced this pull request Dec 20, 2017

doc: explicitly document highWaterMark option
PR-URL: #17049
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>

@gibfahn gibfahn referenced this pull request Dec 20, 2017

Merged

v8.9.4 proposal #17774

@MylesBorins MylesBorins referenced this pull request Dec 20, 2017

Merged

v6.12.3 proposal #17776

msoechting added a commit to hpicgs/node that referenced this pull request Feb 7, 2018

doc: explicitly document highWaterMark option
PR-URL: nodejs#17049
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment