Skip to content

doc: clarify fs.read()

Rodrigo Muino Tomonari requested to merge github/fork/Trott/clarify-fs-read into master

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

Merge request reports