doc: improve net docs #32811
Closed
doc: improve net docs #32811
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
|
@mcollina What is your opinion on rather than duplicating docs (which over time might end up being inconsistent or outdated) we just refer to the stream docs? e.g.
|
Refer back to streams docs for further and more accurate description of behavior details. Refs: nodejs#31916
mscdex
reviewed
Apr 13, 2020
mscdex
reviewed
Apr 13, 2020
mscdex
reviewed
Apr 13, 2020
Co-Authored-By: mscdex <[email protected]>
addaleax
approved these changes
Apr 13, 2020
ronag
added
the
author ready
This comment has been minimized.
This comment has been minimized.
lpinca
reviewed
Apr 13, 2020
This comment has been minimized.
This comment has been minimized.
ronag
commented
Apr 13, 2020
doc/api/net.md
Outdated
| Ensures that no more I/O activity happens on this socket. Only necessary in | ||
| case of errors (parse error or so). | ||
| Ensures that no more I/O activity happens on this socket. This destroys | ||
| the stream but does not explicitly cause a TCP stream reset (RST). |
There was a problem hiding this comment.
@lpinca: please note updated version, better?
There was a problem hiding this comment.
I would honestly not add those details that I think are confusing for most users. "Destroys the stream and closes the connection" is enough. Interested users can dig by themselves to see what happens under the hood.
There was a problem hiding this comment.
Changed to your suggestion.
mscdex
reviewed
Apr 13, 2020
Co-Authored-By: mscdex <[email protected]>
lpinca
approved these changes
Apr 13, 2020
lundibundi
approved these changes
Apr 14, 2020
ronag
added a commit
that referenced
this pull request
Apr 15, 2020
Refer back to streams docs for further and more accurate description of behavior details. Refs: #31916 PR-URL: #32811 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Denys Otrishko <[email protected]>
|
Landed in 9534458 |
MylesBorins
pushed a commit
that referenced
this pull request
Apr 17, 2020
Refer back to streams docs for further and more accurate description of behavior details. Refs: #31916 PR-URL: #32811 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Denys Otrishko <[email protected]>
targos
pushed a commit
to targos/node
that referenced
this pull request
Apr 25, 2020
Refer back to streams docs for further and more accurate description of behavior details. Refs: nodejs#31916 PR-URL: nodejs#32811 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Denys Otrishko <[email protected]>
BridgeAR
pushed a commit
that referenced
this pull request
Apr 28, 2020
Refer back to streams docs for further and more accurate description of behavior details. Refs: #31916 PR-URL: #32811 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Denys Otrishko <[email protected]>
Merged
targos
pushed a commit
that referenced
this pull request
Apr 28, 2020
Refer back to streams docs for further and more accurate description of behavior details. Refs: #31916 PR-URL: #32811 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Denys Otrishko <[email protected]>
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.
Clarify destroy behaviour and refer back to streams docs for further and more accurate
description of behavior details.
Refs: #31916
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes