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

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

Closed
wants to merge 5 commits into from
Closed

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

wants to merge 5 commits into from

Conversation

HACHIMIam
Copy link

@HACHIMIam HACHIMIam commented Aug 22, 2019 •
edited
Loading

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • tests and/or benchmarks are included
  • documentation is changed or added
  • commit message follows commit guidelines

@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 22, 2019
@HACHIMIam HACHIMIam mentioned this pull request Aug 22, 2019
Closed
ronag
ronag requested changes Aug 22, 2019
View reviewed changes
doc/api/fs.md Outdated Show resolved Hide resolved
@HACHIMIam @ronag
Update doc/api/fs.md
2fa552c 
Co-Authored-By: Robert Nagy <ronagy@icloud.com>
@trivikr
Copy link
Member

trivikr commented Aug 23, 2019

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/3850/

jasnell
jasnell previously approved these changes Aug 23, 2019
View reviewed changes
@trivikr trivikr added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Aug 23, 2019
lpinca
lpinca previously approved these changes Aug 23, 2019
View reviewed changes
@addaleax addaleax removed the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Aug 25, 2019
addaleax
addaleax requested changes Aug 25, 2019
View reviewed changes
Copy link
Member

@addaleax addaleax left a comment

Choose a reason for hiding this comment

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

@jasnell @trivikr @lpinca Are you sure this is more understandable than before? The data will be read from the disk and written into the buffer (i.e. the access to the buffer memory is a write-only one), so I’m not sure that we should land this as-is.

doc/api/fs.md Outdated Show resolved Hide resolved
@HACHIMIam @addaleax
Update doc/api/fs.md
9c6068d 
Co-Authored-By: Anna Henningsen <github@addaleax.net>
@trivikr trivikr requested a review from addaleax August 27, 2019 14:15
@trivikr
Copy link
Member

trivikr commented Aug 27, 2019

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/3863/

addaleax
addaleax reviewed Aug 27, 2019
View reviewed changes
doc/api/fs.md Outdated Show resolved Hide resolved
@jasnell
Copy link
Member

jasnell commented Aug 28, 2019

@addaleax I'm good with the before or after. If you think the original reads better then I'm good with that also.

@addaleax
Copy link
Member

I still feel like the second line change here sounds a lot like implying that the Buffer is the data source here. It can be reading into if that’s better, but reading from really doesn’t work here, imo.

@jasnell
Copy link
Member

jasnell commented Aug 28, 2019

As I said, i'm good with your read on it @addaleax. I'll clear my +1

@jasnell jasnell dismissed their stale review August 28, 2019 23:15

Happy with @addaleax's rejection and reasoning

@lpinca lpinca dismissed their stale review September 9, 2019 16:30

I agree with @addaleax. Sorry I did not review carefully.

@BridgeAR
Copy link
Member

Ping @HACHIMIam would you please change the second part as suggested?

@HACHIMIam
Copy link
Author

@BridgeAR done

BridgeAR
BridgeAR reviewed Jan 12, 2020
View reviewed changes
doc/api/fs.md Outdated
@@ -2503,7 +2503,7 @@ 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 •
edited
Loading

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

@HarshithaKP
Copy link
Member

Looks like this was ready to be landed long back, but not sure why got stalled.

@gireeshpunathil gireeshpunathil added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Apr 1, 2020
@gireeshpunathil
Copy link
Member

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/4157

@addaleax
Copy link
Member

addaleax commented Apr 2, 2020

Landed in 0c70e8c

@addaleax addaleax closed this Apr 2, 2020
addaleax pushed a commit that referenced this pull request Apr 2, 2020
@hachimiSfeir @addaleax
doc: improve fs.read documentation
0c70e8c 
PR-URL: #29270
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
BethGriggs pushed a commit that referenced this pull request Apr 7, 2020
@hachimiSfeir @BethGriggs
doc: improve fs.read documentation
1ad6995 
PR-URL: #29270
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
targos pushed a commit that referenced this pull request Apr 12, 2020
@hachimiSfeir @targos
doc: improve fs.read documentation
b6f7196 
PR-URL: #29270
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@targos targos mentioned this pull request Apr 13, 2020
Merged
targos pushed a commit that referenced this pull request Apr 22, 2020
@hachimiSfeir @targos
doc: improve fs.read documentation
4b417f8 
PR-URL: #29270
Reviewed-By: Robert Nagy <ronagy@icloud.com>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@targos targos mentioned this pull request Apr 22, 2020
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BridgeAR BridgeAR BridgeAR approved these changes

@ronag ronag ronag approved these changes

@trivikr trivikr trivikr approved these changes

@cjihrig cjihrig cjihrig approved these changes

@addaleax addaleax addaleax approved these changes

@lpinca lpinca lpinca left review comments

@jasnell jasnell jasnell left review comments

Assignees
No one assigned
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. 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.