docs: added documentation for socket.destroyed#6128
docs: added documentation for socket.destroyed#6128tusharmath wants to merge 7 commits intonodejs:masterfrom
Conversation
|
My apologies if some guidelines haven't been met. This is my first contribution. |
doc/api/net.markdown
Outdated
|
|
||
| ### socket.destroyed | ||
|
|
||
| A `boolean` value that depicts if the connection is destroyed or not. |
There was a problem hiding this comment.
Can we add a bit more detail about what "destroyed" means?
There was a problem hiding this comment.
Look into the source to find out, I think something along the lines of "does not send or receive any more data, cannot be re-established", but I'm no expert on this topic :).
There was a problem hiding this comment.
I think "indicates" might be a better choice of word than "depicts". Maybe something like this:
A
Booleanvalue that indicates whether the connection has been destroyed or not.
|
The subsystem should be |
|
@nodejs/documentation |
|
Hey, thanks, please wrap lines at 80 chars :) |
7da4fd4 to
c7066fb
Compare
|
@tusharmath ping. Are you still planning to work on this? |
|
@cjihrig Made the updates. |
|
Might be me, but I think this sounds better:
Not strictly necessary for this PR, but I think some information whether a half-closed socket can be in a |
|
LGTM |
|
Sorry, I do have one nit:
should be
|
|
@cjihrig update the changes |
|
Sorry, I just realized this - can you maintain the alphabetical order of the docs. |
|
@cjihrig Thanks for pointing it out :) |
|
Thanks! Landed in 193afef. |
Checklist
Affected core subsystem(s)
doc
Description of change
fixes: #5898