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

doc: use serial comma in fs docs #43104

Merged
merged 1 commit into from
May 15, 2022

Conversation

tniessen
Copy link
Member

* [Use serial commas][].

Refs: #11321
Refs: #17384

@tniessen tniessen added the fast-track PRs that do not need to wait for 48 hours to land. label May 14, 2022
@github-actions
Copy link
Contributor

Fast-track has been requested by @tniessen. Please 👍 to approve.

@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 May 14, 2022
Copy link
Contributor

@LiviaMedeiros LiviaMedeiros left a comment

Choose a reason for hiding this comment

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

Nits, feel free to ignore or leave for later:

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

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

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

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

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`.

@tniessen tniessen force-pushed the doc-serial-comma-fs branch from 1238886 to d9a91c4 Compare May 15, 2022 14:18
@tniessen
Copy link
Member Author

Thanks @LiviaMedeiros, I missed those! Force-pushed, the actual diff since the first commit is 1238886. PTAL.

@tniessen tniessen force-pushed the doc-serial-comma-fs branch from cf0fb14 to 4aac703 Compare May 15, 2022 16:45
@tniessen
Copy link
Member Author

Thanks for catching that @LiviaMedeiros! Force-pushed again, the actual diff is cf0fb14.

@LiviaMedeiros LiviaMedeiros added the commit-queue Add this label to land a pull request using GitHub Actions. label May 15, 2022
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label May 15, 2022
@nodejs-github-bot nodejs-github-bot merged commit d1d30d7 into nodejs:master May 15, 2022
@nodejs-github-bot
Copy link
Collaborator

Landed in d1d30d7

BethGriggs pushed a commit that referenced this pull request May 16, 2022
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
juanarbol pushed a commit that referenced this pull request May 31, 2022
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>
danielleadams pushed a commit that referenced this pull request Jun 27, 2022
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>
targos pushed a commit that referenced this pull request Jul 12, 2022
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>
targos pushed a commit that referenced this pull request Jul 31, 2022
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>
guangwong pushed a commit to noslate-project/node that referenced this pull request Oct 10, 2022
Refs: nodejs/node#11321
Refs: nodejs/node#17384

PR-URL: nodejs/node#43104
Reviewed-By: LiviaMedeiros <livia@cirno.name>
Reviewed-By: Rich Trott <rtrott@gmail.com>
Reviewed-By: Darshan Sen <raisinten@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. fast-track PRs that do not need to wait for 48 hours to land. fs Issues and PRs related to the fs subsystem / file system.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants