net socket write signature docs #19967
Conversation
nodejs-github-bot
added
doc
addaleax
left a comment
addaleax
left a comment
There was a problem hiding this comment.
We should probably also link to https://nodejs.org/api/stream.html#stream_writable_write_chunk_encoding_callback_1 – it’s the same function
doc/api/net.md
Outdated
| added: v0.1.90 | ||
| --> | ||
|
|
||
| * `data` {string|Buffer} |
doc/api/net.md
Outdated
| The optional `callback` parameter will be executed when the data is finally | ||
| written out - this may not be immediately. | ||
|
|
||
| See Writable stream [`_write()`][stream_writable_write] method for more information. |
There was a problem hiding this comment.
It's probably better to link to https://nodejs.org/dist/latest/docs/api/stream.html#stream_writable_write_chunk_encoding_callback instead of _write()
vsemozhetbyt
left a comment
vsemozhetbyt
left a comment
There was a problem hiding this comment.
Thank you. LGTM with some nits)
doc/api/net.md
Outdated
| --> | ||
|
|
||
| * `data` {string|Buffer|Uint8Array} | ||
| * `encoding` {string} **Default:** `UTF8` |
There was a problem hiding this comment.
It seems this should be `'utf8'`
There was a problem hiding this comment.
Also to be strict, we could specify that it is only used when data is a string but maybe it's obvious.
doc/api/net.md
Outdated
| [socket(7)]: http://man7.org/linux/man-pages/man7/socket.7.html | ||
| [unspecified IPv4 address]: https://en.wikipedia.org/wiki/0.0.0.0 | ||
| [unspecified IPv6 address]: https://en.wikipedia.org/wiki/IPv6_address#Unspecified_address | ||
| [stream_writable_write]: stream.html#stream_writable_write_chunk_encoding_callback |
There was a problem hiding this comment.
This should go after [socket(7)]:, alphabetically.
|
@cancerberoSgx It seems your local email is not included in the GitHub email list. Please, check these notes to fix this) |
vsemozhetbyt
left a comment
vsemozhetbyt
left a comment
There was a problem hiding this comment.
With some new nits)
doc/api/net.md
Outdated
| --> | ||
|
|
||
| * `data` {string|Buffer|Uint8Array} | ||
| * `encoding` {string} **Default:** `utf8`. Only used when data is `string` |
There was a problem hiding this comment.
Sorry to bother again. Our doc parsers expect 'Default' part to be the last one. So this should be:
Only used when data is `string`. **Default:** `'utf8'`.
doc/api/net.md
Outdated
| The optional `callback` parameter will be executed when the data is finally | ||
| written out - this may not be immediately. | ||
|
|
||
| See Writable stream [`write()`][stream_writable_write] method for more information. |
There was a problem hiding this comment.
This line should be wrapped after 80 characters.
vsemozhetbyt
added
fast-track
PR-URL: nodejs#19967 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
|
Landed in 8e30589 🎉 |
|
thanks everybody, I'm very happy!!, this is my first contribution to this great project - hope not my last one, thanks! |
PR-URL: #19967 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
PR-URL: nodejs#19967 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
7 participants
document net.Socket.write method signature - just that. Had a good description but the method signature was not documented. tried make doc without problems. Thanks