doc: supplementary explanation for 'readable' event #16932
Conversation
nodejs-github-bot
added
doc
|
Hey, thanks for the contribution! I don't think the docs are clearer after that change than before it. Sorry. |
|
@benjamingr I just find that sometimes new data pushed to the queue will not trigger the readable event =.= . I think we should point out it |
doc/api/stream.md
Outdated
| @@ -774,7 +774,7 @@ end | |||
| *Note*: In general, the `readable.pipe()` and `'data'` event mechanisms are | |||
| easier to understand than the `'readable'` event. | |||
| However, handling `'readable'` might result in increased throughput. | |||
|
|
|||
| in the Meanwhile, new data will not trigger `'readable'` event everytime. | |||
There was a problem hiding this comment.
“In” should be capitalized. ‘readable’ is emitted if ‘read()’ returned null the last time it was called (from memory, please verify).
|
@Aaaaaaaty Thanks so much for your first commit 🎉. Do you want to take a stab at the changes @mcollina suggested? |
|
@fhinkel @mcollina hi I just noticed that directly execute _read () to push the data except using read(), it will not trigger readable. So I think maybe it is better to point out it. Although few people use it in that way =.=. I will update my pr and maybe you can tell me a good way to explain this condition. Thanks all~ |
doc/api/stream.md
Outdated
| @@ -774,7 +774,7 @@ end | |||
| *Note*: In general, the `readable.pipe()` and `'data'` event mechanisms are | |||
| easier to understand than the `'readable'` event. | |||
| However, handling `'readable'` might result in increased throughput. | |||
|
|
|||
| In the Meanwhile, new data will not trigger `'readable'` event everytime. | |||
There was a problem hiding this comment.
meanwhilerather thanMeanwhile, although I'm not sure ifIn the meanwhileis necessary or clear. The word meanwhile suggests something else is happening. It's not clear what is happening. Maybe use "While" instead? Like "While the foo event is queued but has not yet been emitted, new data will not..."?
Smaller nits:
trigger a `'readable'` event rather thantrigger'readable'event`every timerather thaneverytime.- blank line after this line
The nits can be handled by someone landing the PR but if you're going in to edit some more anyway, maybe take care of them then.
Checklist
Affected core subsystem(s)
supplementary explanation for 'readable' event