FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: fix doc for Buffer.readInt32LE() by ghaiklor · Pull Request #5890 · nodejs/node · GitHub

/ node Public

doc: fix doc for Buffer.readInt32LE() - #5890

Closed
ghaiklor wants to merge 2 commits into
nodejs:masterfrom
ghaiklor:doc/5889
ConversationCommits (2)ChecksFiles changed
Closed

doc: fix doc for Buffer.readInt32LE()#5890
ghaiklor wants to merge 2 commits into
nodejs:masterfrom
ghaiklor:doc/5889

Conversation

ghaiklor commented Mar 24, 2016

Copy link
Copy Markdown
Contributor

Pull Request check-list

  • Is the commit message formatted according to [CONTRIBUTING.md][0]?
  • Is a documentation update included (if this change modifies
    existing APIs, or introduces new ones)?

Affected core subsystem(s)

doc

Description of change

Update example and signature for readInt32LE method. It fixes #5889.

doc: fix doc for Buffer.readInt32LE()
fd6367a 
Update example and signature for readInt32LE method.

jasnell commented Mar 24, 2016

Copy link
Copy Markdown
Member

LGTM

jasnell added buffer Issues and PRs related to the buffer subsystem. doc Issues and PRs related to the documentations. labels Mar 24, 2016

cjihrig commented Mar 24, 2016

Copy link
Copy Markdown
Contributor

LGTM. Do the other similar methods have the same problem? If so, might as well fix those too.

ghaiklor commented Mar 24, 2016

Copy link
Copy Markdown
Contributor Author

@cjihrig @jasnell Each signature of read* methods has 0 <= offset <= buf.length - 8\4\2, starting from readDoubleBE().

I think all of them should be fixed to 0 <= offset < buf.length - 8\4\2. If so, I'll update PR.

ghaiklor commented Mar 24, 2016

Copy link
Copy Markdown
Contributor Author

Ouch, mistake was not in offsets. They are correct.

We have const buf = Buffer.from([1, -2, 3, 4]);. buf.readInt8() reads 8 bytes starting from offset. offset can be in range 0 <= offset <= 4 - 1 in our case. buf.readInt8(3) returns the correct result.

I'll update PR with correct version now.

cjihrig commented Mar 24, 2016

Copy link
Copy Markdown
Contributor

You're right. Thank you.

bendiy commented Mar 25, 2016

Copy link
Copy Markdown

@cjihrig I ran most of the other buf.readXXX() doc examples today and they seemed to be correct.

cjihrig commented Mar 25, 2016

Copy link
Copy Markdown
Contributor

@bendiy thanks for investigating.

thefourtheye pushed a commit that referenced this pull request Mar 27, 2016
doc: fix doc for Buffer.readInt32LE()
1213535 
Update example of readInt32LE method. buf.readInt32LE(1) is supposed to
throw an error as it has only four elements and it tries to read 32
bits from three bytes.

Fixes: #5889
PR-URL: #5890
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>

thefourtheye commented Mar 27, 2016

Copy link
Copy Markdown
Contributor

LGTM and landed in 1213535. I squashed the commits and reworded the commit log a bit.

ghaiklor deleted the doc/5889 branch March 27, 2016 07:11
evanlucas pushed a commit that referenced this pull request Mar 30, 2016
doc: fix doc for Buffer.readInt32LE()
715ba18 
Update example of readInt32LE method. buf.readInt32LE(1) is supposed to
throw an error as it has only four elements and it tries to read 32
bits from three bytes.

Fixes: #5889
PR-URL: #5890
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>

MylesBorins commented Mar 30, 2016

Copy link
Copy Markdown
Contributor

should this be backported to v4?

evanlucas mentioned this pull request Mar 31, 2016
Closed
evanlucas pushed a commit that referenced this pull request Mar 31, 2016
doc: fix doc for Buffer.readInt32LE()
f1f9aff 
Update example of readInt32LE method. buf.readInt32LE(1) is supposed to
throw an error as it has only four elements and it tries to read 32
bits from three bytes.

Fixes: #5889
PR-URL: #5890
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>

thefourtheye commented Apr 2, 2016

Copy link
Copy Markdown
Contributor

@thealphanerd Yes, this should be backported to 4.x

MylesBorins pushed a commit that referenced this pull request Apr 9, 2016
doc: fix doc for Buffer.readInt32LE()
6e2bfbe 
Update example of readInt32LE method. buf.readInt32LE(1) is supposed to
throw an error as it has only four elements and it tries to read 32
bits from three bytes.

Fixes: #5889
PR-URL: #5890
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
MylesBorins mentioned this pull request Apr 11, 2016
Merged
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

buffer Issues and PRs related to the buffer subsystem. doc Issues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

doc: Buffer buf.readInt32LE(offset[, noAssert]) example incorrect

6 participants

Back | FazBrowse Home | New Git URL