socket encodings don't link to possible encoding values, and describe behaviour which does not exist #11352
Labels
doc
Issues and PRs related to the documentations.
good first issue
Issues that are suitable for first-time contributors.
net
Issues and PRs related to the net subsystem.
Comments
sam-github
added
doc
sam-github
added
the
good first issue
|
@RickBullotta If you'd like to get involved in making this better, this is a good first contribution. |
|
@sam-github Could I give it a shot? I never contributed before but this seems like a good starting point. |
|
@QuentinGibson - I already fixed the issue with the docs in readable.setEncoding() and submitted a pull request submitted. However, if you want to tackle documentation for the specific encoders and when/where they are used, and linking to the encoder docs from appropriate spots, that would be awesome.
Thanks!
|
|
Edit: @RickBullotta For clarification, are encoders 'utf-8', 'hex', etc. |
1 task
anchnk
pushed a commit
to anchnk/node
that referenced
this issue
May 19, 2017
Removed an incorrect reference to the use of setEncoding(null) as the proper way to handling binary streams or to disable encoding, and explained that the default encoding is "no encoding", and that this is the correct approach for dealing with binary data via Buffers. PR-URL: nodejs#11363 Fixes: nodejs#11352 Refs: nodejs#11316 Reviewed-By: Sam Roberts <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
MylesBorins
pushed a commit
that referenced
this issue
Jul 17, 2017
Removed an incorrect reference to the use of setEncoding(null) as the proper way to handling binary streams or to disable encoding, and explained that the default encoding is "no encoding", and that this is the correct approach for dealing with binary data via Buffers. PR-URL: #11363 Fixes: #11352 Refs: #11316 Reviewed-By: Sam Roberts <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Gibson Fahnestock <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The documentation at:
https://nodejs.org/api/stream.html#stream_readable_setencoding_encoding
...does not describe what all of the supported encodings are (there are more than just 'UTF8' and 'hex'), nor does it link to any further documentation on them. Also, this documentation refers to "setEncoding(null)" as the recommended approach for binary streams, which is incorrect and does not work (this defaults to UTF8 encoding). There also appears to be an undocumented or semi-documented 'binary' encoding.
On the other hand, the documentation for use of encodings on Buffer objects is comprehensive and informative:
https://nodejs.org/api/buffer.html#buffer_buffers_and_character_encodings
Reported in comment #11316 (comment) by @RickBullotta, I have not verified
setEncoding(null)not working.The text was updated successfully, but these errors were encountered: