doc: add warning to readline's close() method #22679
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
doc
vsemozhetbyt
approved these changes
Sep 3, 2018
vsemozhetbyt
added
the
author ready
|
Node.js Collaborators, please, add 👍 here if you approve fast-tracking. |
Trott
approved these changes
Sep 4, 2018
Trott
reviewed
Sep 4, 2018
| @@ -195,6 +195,9 @@ The `rl.close()` method closes the `readline.Interface` instance and | |||
| relinquishes control over the `input` and `output` streams. When called, | |||
| the `'close'` event will be emitted. | |||
|
|
|||
| Calling `rl.close()` does not immediately stop other events (including `'line'`) | |||
There was a problem hiding this comment.
Micro-nit: Is immediately meaningful here? Would it be better without it?
There was a problem hiding this comment.
Instead of immediately, might necessarily be better?
There was a problem hiding this comment.
I copied the text from the pause() docs for consistency. That said, I'm open to using any wording here if you feel strongly enough.
There was a problem hiding this comment.
It’s a nit. I don’t feel strongly.
trivikr
approved these changes
Sep 4, 2018
gdams
approved these changes
Sep 4, 2018
jasnell
approved these changes
Sep 4, 2018
lpinca
approved these changes
Sep 4, 2018
BridgeAR
approved these changes
Sep 5, 2018
When close() is called on a readline instance, it is possible that data is already buffered, and will trigger 'line' events. This commit adds a warning to the corresponding docs. Note that a similar warning already exists for the pause() method. PR-URL: nodejs#22679 Fixes: nodejs#22615 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: George Adams <george.adams@uk.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
targos
pushed a commit
that referenced
this pull request
Sep 7, 2018
When close() is called on a readline instance, it is possible that data is already buffered, and will trigger 'line' events. This commit adds a warning to the corresponding docs. Note that a similar warning already exists for the pause() method. PR-URL: #22679 Fixes: #22615 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com> Reviewed-By: George Adams <george.adams@uk.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When
close()is called on areadlineinstance, it is possible that data is already buffered, and will trigger'line'events. This commit adds a warning to the corresponding docs. Note thata similar warning already exists for the
pause()method.Fixes: #22615
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes