-
Notifications
You must be signed in to change notification settings - Fork 29.9k
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: multiple improvements in Stream docs #5009
Conversation
returns false, at which point it should stop reading from the resource. Only | ||
when \_read is called again after it has stopped should it start reading | ||
more data from the resource and pushing that data onto the queue. | ||
When `_read()` is called, if data is available from the resource, this method |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you change this method
to the _read() implementation
?
Great work! Once the wording nit is corrected, this LGTM. We usually leave PRs open once they've been LGTM'd for about 48 hours to make sure all of the contributors get a chance to review. If no one has objections it should be merged shortly after that. Thanks for the contribution! |
is consumed. | ||
|
||
Buffering in Writable streams happens when the user calls | ||
[`stream.write(chunk)`][] repeatedly, even when `write()` returns `false`. | ||
[`stream.write(chunk)`][] repeatedly, even when [`write()`][] returns `false`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can't we simply say 'it returns'?
@thefourtheye BTW, I was wondering. In this file there are a lot of duplicates and in others which I worked on too. Maybe replace those where possible by some default except places where arguments matter to the context of sentences (like "for this case use |
@estliberitas Yes, I was about to talk to you about the same (I couldn't earlier because I was on Mobile). What we probably can do is, use |
@thefourtheye Well, I find it a good idea. And as for multiple arguments, we just separate by comma? Like, for example, lines 1582-1583:
To me it's not so cool, but at least it's informative and saves us from copy-pasting a lot. Other concern is optional arguments:
|
@thefourtheye Other idea would be patch doc tool to look for links without arguments 😉 |
Or we can use a common name like this |
@thefourtheye Wow, I got something new today. Thanks, I think that resolves all the questions above. |
@chrisdickinson @thefourtheye Guys, please check once have a time. To simplify life I made a small script to check links consistency: https://gist.github.com/estliberitas/bfd35c7a5a977aa5d221 |
Sweeeet :-) |
LGTM |
Please go ahead and submit PRs. I always wanted to clean this thing myself. Glad you are doing this :-) |
LGTM |
@thefourtheye will do ;) |
@estliberitas ... there have been some other changes that touch on the same file, can I ask you to rebase this and update so we can remove the duplication? Thank you! |
Yep, I guess it's #5007, ok will do now. |
Add missing links, remove duplicate ones, fix constants and functions styling. Minor lexical corrections.
@jasnell done |
LGTM. Thank you! |
Add missing links, remove duplicate ones, fix constants and functions styling. Minor lexical corrections. PR-URL: #5009 Reviewed-By: Stephen Belanger <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: James M Snell <[email protected]>
Landed in b0b4aeb |
Add missing links, remove duplicate ones, fix constants and functions styling. Minor lexical corrections. PR-URL: #5009 Reviewed-By: Stephen Belanger <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: James M Snell <[email protected]>
Add missing links, remove duplicate ones, fix constants and functions styling. Minor lexical corrections. PR-URL: #5009 Reviewed-By: Stephen Belanger <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: James M Snell <[email protected]>
Add missing links, remove duplicate ones, fix constants and functions styling. Minor lexical corrections. PR-URL: #5009 Reviewed-By: Stephen Belanger <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: James M Snell <[email protected]>
Add missing links, remove duplicate ones, fix constants and functions styling. Minor lexical corrections. PR-URL: #5009 Reviewed-By: Stephen Belanger <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: James M Snell <[email protected]>
Add missing links, remove duplicate ones, fix constants and functions styling. Minor lexical corrections. PR-URL: nodejs#5009 Reviewed-By: Stephen Belanger <[email protected]> Reviewed-By: Sakthipriyan Vairamani <[email protected]> Reviewed-By: James M Snell <[email protected]>
Add links, fix constants and functions styling. Minor lexical corrections.