Skip to content
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: improve net docs #32811

Closed
wants to merge 7 commits into from
Closed
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fixup: add note regarding TCP rst
  • Loading branch information
ronag committed Apr 13, 2020
commit b70cdcfe5199c07d7d6130bba6c779c60a54993b
3 changes: 2 additions & 1 deletion doc/api/net.md
Original file line number Diff line number Diff line change
Expand Up @@ -730,7 +730,8 @@ added: v0.1.90
* `error` {Object}
* Returns: {net.Socket}

Ensures that no more I/O activity happens on this socket.
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).
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lpinca: please note updated version, better?

Copy link
Member

@lpinca lpinca Apr 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed to your suggestion.


See, [`writable.destroy()`][] for further details.
ronag marked this conversation as resolved.
Show resolved Hide resolved

Expand Down