Adding clarity to buffer toString docs. #8984
Closed
Conversation
This file contains hidden or 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
As discussed in nodejs#8971, the docs for this method could be improved. Fixes: nodejs#8971
nodejs-github-bot
added
buffer
addaleax
reviewed
Oct 8, 2016
| // Prints: tés | ||
| console.log(buf.toString('utf8', 0, 3)); | ||
| // Prints: 74c3a97374 | ||
| console.log(buf2.toString('hex')); |
Member
There was a problem hiding this comment.
I know this isn’t mentioned in #8971, but the console.log(buf.toString(…)) statements should probably refer to buf1, not buf, so it would make sense to fix that, too?
cjihrig
reviewed
Oct 8, 2016
doc/api/buffer.md
Outdated
| * `encoding` {String} The character encoding to decode to. **Default:** `'utf8'` | ||
| * `start` {Integer} Where to start decoding. **Default:** `0` | ||
| * `end` {Integer} Where to stop decoding (not inclusive). **Default:** [`buf.length`] | ||
| * `start` {Integer} They byte offset to start decoding at. **Default:** `0` |
jasnell
reviewed
Oct 8, 2016
| * `start` {Integer} Where to start decoding. **Default:** `0` | ||
| * `end` {Integer} Where to stop decoding (not inclusive). **Default:** [`buf.length`] | ||
| * `start` {Integer} The byte offset to start decoding at. **Default:** `0` | ||
| * `end` {Integer} The byte offset to stop decoding at (not inclusive). **Default:** [`buf.length`] |
rvagg
force-pushed
the
master
branch
2 times, most recently
from
c133999 to
83c7a88
Compare
Member
|
Landed in 366fc7a. fixed nits on landing |
Merged
This was referenced Nov 30, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
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.
Checklist
Affected core subsystem(s)
Update to the docs
Description of change
As discussed in #8971, the docs for this method could be improved. This is my attempt at clarification.
Fixes: #8971