The Wayback Machine - https://web.archive.org/web/20220517174233/https://github.com/nodejs/node/pull/43104
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

Jump to bottom

doc: use serial comma in fs docs #43104

Merged
merged 1 commit into from May 15, 2022
Merged

doc: use serial comma in fs docs #43104

merged 1 commit into from May 15, 2022
+25 −25

Conversation

tniessen
Copy link
Member

@tniessen tniessen commented May 14, 2022

node/doc/README.md

Line 21 in 5e9274a

* [Use serial commas][].

Refs: #11321
Refs: #17384
@tniessen tniessen added the fast-track label May 14, 2022
@github-actions
Copy link

@github-actions github-actions bot commented May 14, 2022

Fast-track has been requested by @tniessen. Please 👍 to approve.
@nodejs-github-bot nodejs-github-bot added doc fs labels May 14, 2022
LiviaMedeiros
LiviaMedeiros approved these changes May 14, 2022
View changes
Copy link
Contributor

@LiviaMedeiros LiviaMedeiros left a comment

Nits, feel free to ignore or leave for later:

node/doc/api/fs.md

Line 1562 in 4d5bbc7

`data` can be a string, a buffer, an {AsyncIterable} or {Iterable} object.

node/doc/api/fs.md

Line 1687 in 4d5bbc7

`fs.open()`, `fs.readFile()` or `fs.writeFile()`. Doing

node/doc/api/fs.md

Line 2412 in 4d5bbc7

`fs.open()`, `fs.readFile()` or `fs.writeFile()` is not recommended. Doing

node/doc/api/fs.md

Line 3876 in 4d5bbc7

`fs.open()`, `fs.readFile()` or `fs.writeFile()` is not recommended.

node/doc/api/fs.md

Line 7524 in 4d5bbc7

through `fs.open()` or `fs.writeFile()` or `fsPromises.open()`) will fail with

Out of curiosity, maybe comma should be used in those as well, since any TypedArray is equivalent of Int8Array, ..., or Float64Array:

node/doc/api/fs.md

Lines 4395 to 4396 in 4d5bbc7

description: The `buffer` parameter can now be any `TypedArray` or a
`DataView`.

Trott
Trott approved these changes May 15, 2022
View changes
@tniessen
Copy link
Member Author

@tniessen tniessen commented May 15, 2022

Thanks @LiviaMedeiros, I missed those! Force-pushed, the actual diff since the first commit is 1238886. PTAL.
LiviaMedeiros
LiviaMedeiros reviewed May 15, 2022
View changes
doc/api/fs.md Show resolved Hide resolved
@tniessen
Copy link
Member Author

@tniessen tniessen commented May 15, 2022

Thanks for catching that @LiviaMedeiros! Force-pushed again, the actual diff is cf0fb14.
@LiviaMedeiros LiviaMedeiros added the commit-queue label May 15, 2022
@nodejs-github-bot nodejs-github-bot removed the commit-queue label May 15, 2022
@nodejs-github-bot nodejs-github-bot merged commit d1d30d7 into nodejs:master May 15, 2022
15 checks passed
@nodejs-github-bot
Copy link
Contributor

@nodejs-github-bot nodejs-github-bot commented May 15, 2022

Landed in d1d30d7
BethGriggs pushed a commit that referenced this issue May 16, 2022
@tniessen @BethGriggs
doc: use serial comma in fs docs
f53ed9d 
Refs: #11321
Refs: #17384

PR-URL: #43104
Reviewed-By: LiviaMedeiros <livia@cirno.name>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
@RafaelGSS RafaelGSS mentioned this pull request May 16, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc fast-track fs
5 participants
@tniessen @nodejs-github-bot @Trott @RaisinTen @LiviaMedeiros