doc: do not mention TCP in the allowHalfOpen option description #38360
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
addaleax
approved these changes
Apr 22, 2021
marsonya
approved these changes
Apr 22, 2021
jasnell
approved these changes
Apr 22, 2021
The `allowHalfOpen` option works in the same way for both TCP and IPC connections. Fixes: nodejs#38307
lpinca
changed the title
Trott
reviewed
Apr 24, 2021
doc/api/net.md
Outdated
Comment on lines
554
to
555
| * `allowHalfOpen` {boolean} Indicates whether to automatically end the | ||
| writable side when the readable side ends. See [`net.createServer()`][] and |
There was a problem hiding this comment.
Does this make it sound like you should set it to true to automatically end the writable side when in fact the opposite is true?
There was a problem hiding this comment.
- Indicates whether to not automatically end the writable side when the readable side ends.
- Indicates whether to keep the writable side open when the readable side ends.
- Other suggestions?
There was a problem hiding this comment.
PTAL, I've used the same wording used here https://nodejs.org/api/stream.html#stream_new_stream_duplex_options.
Trott
approved these changes
Apr 27, 2021
|
Landed in d432386. |
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.
The
allowHalfOpenoption works in the same way for both TCP and IPCconnections.
Fixes: #38307