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.

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

fix fs.read documentation typo read instead of write #29270

Closed
wants to merge 5 commits into from
Closed
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2503,9 +2503,9 @@ changes:

Read data from the file specified by `fd`.

`buffer` is the buffer that the data will be written to.
`buffer` is the buffer that the data which was read from the fd will be written to.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line exceeds the maximum allowed line length.

Suggested change
`buffer` is the buffer that the data which was read from the fd will be written to.
`buffer` is the buffer that the data which was read from the fd will be written
to.

Copy link
Author

@HACHIMIam HACHIMIam Jan 14, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@BridgeAR i tried reduce the line length


`offset` is the offset in the buffer to start writing at.
`offset` is the offset in the buffer to start reading from.
HACHIMIam marked this conversation as resolved.
Show resolved Hide resolved

`length` is an integer specifying the number of bytes to read.

Expand Down