Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: clarify fs.read() #14631

Closed
wants to merge 2 commits into from
Closed

doc: clarify fs.read() #14631

wants to merge 2 commits into from

Conversation

Trott
Copy link
Member

@Trott Trott commented Aug 4, 2017

First commit (originally from #14612, closed by OP, authorship of @dcharbonnier retained in the commit, hope this isn't rude of me, this PR is just me trying to get that across the finish line):

doc: clarify the position argument for fs.read

What happen to the file position after a read using a position null or
integer was not clear and you can assume that the cursor of the file
descriptor is updated even if position is an integer.

Fixes: https://github.com/nodejs/node/issues/8397

Second commit (implements a few of the comments from that PR):

doc: improve fs.read() doc text
Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc fs

dcharbonnier and others added 2 commits August 4, 2017 09:39
@dcharbonnier @Trott
doc: clarify the position argument for fs.read
75fa646 
What happen to the file position after a read using a position null or
integer was not clear and you can assume that the cursor of the file
descriptor is updated even if position is an integer.

Fixes: nodejs#8397
@Trott
doc: improve fs.read() doc text
93f3932
@Trott Trott added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Aug 4, 2017
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Aug 4, 2017
@Trott
Copy link
Member Author

Trott commented Aug 4, 2017

(If OP wants to re-open #14612, I'm totally happy to close this, or remove their commit so there's no conflict, or whatever.)

@Trott
Copy link
Member Author

Trott commented Aug 7, 2017

Landed in 680285c and 0f325aa

Thanks, @dcharbonnier! 🎉

@Trott Trott closed this Aug 7, 2017
Trott pushed a commit that referenced this pull request Aug 7, 2017
@dcharbonnier @Trott
doc: clarify the position argument for fs.read
680285c 
What happen to the file position after a read using a position null or
integer was not clear and you can assume that the cursor of the file
descriptor is updated even if position is an integer.

PR-URL: #14631
Fixes: #8397
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Trott added a commit that referenced this pull request Aug 7, 2017
@Trott
doc: improve fs.read() doc text
0f325aa 
PR-URL: #14631
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
addaleax pushed a commit that referenced this pull request Aug 10, 2017
@dcharbonnier @addaleax
doc: clarify the position argument for fs.read
d604173 
What happen to the file position after a read using a position null or
integer was not clear and you can assume that the cursor of the file
descriptor is updated even if position is an integer.

PR-URL: #14631
Fixes: #8397
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
addaleax pushed a commit that referenced this pull request Aug 10, 2017
@Trott @addaleax
doc: improve fs.read() doc text
9888bb1 
PR-URL: #14631
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
@addaleax addaleax mentioned this pull request Aug 13, 2017
Merged
@MylesBorins
Copy link
Contributor

is this relevant to v6.x?

@Trott
Copy link
Member Author

Trott commented Sep 19, 2017

is this relevant to v6.x?

I believe so. I think it applies to 4.x as well. @nodejs/fs

MylesBorins pushed a commit that referenced this pull request Sep 20, 2017
@dcharbonnier @MylesBorins
doc: clarify the position argument for fs.read
5a7a49f 
What happen to the file position after a read using a position null or
integer was not clear and you can assume that the cursor of the file
descriptor is updated even if position is an integer.

PR-URL: #14631
Fixes: #8397
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
MylesBorins pushed a commit that referenced this pull request Sep 20, 2017
@Trott @MylesBorins
doc: improve fs.read() doc text
f8fbac7 
PR-URL: #14631
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
@MylesBorins MylesBorins mentioned this pull request Sep 20, 2017
Merged
@Trott Trott deleted the clarify-fs-read branch January 13, 2022 22:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jasnell jasnell jasnell approved these changes

@cjihrig cjihrig cjihrig approved these changes

@tniessen tniessen tniessen approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@Trott @MylesBorins @jasnell @cjihrig @tniessen @nodejs-github-bot @dcharbonnier