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: fix incorrect fs.readFileSync example output #20902

Conversation

not-an-aardvark
Copy link
Contributor

This fixes an incorrect example in the documentation for calling
fs.readFileSync on a directory. The example was presumably copied from
the documentation for fs.readFile, which has an error argument in its
callback.

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

This fixes an incorrect example in the documentation for calling
`fs.readFileSync` on a directory. The example was presumably copied from
the documentation for `fs.readFile`, which has an error argument in its
callback.
@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 22, 2018
@addaleax addaleax added the fast-track PRs that do not need to wait for 48 hours to land. label May 23, 2018
@not-an-aardvark
Copy link
Contributor Author

@Trott
Copy link
Member

Trott commented May 23, 2018

+1 to fast-tracking after a green CI run

not-an-aardvark added a commit that referenced this pull request May 23, 2018
This fixes an incorrect example in the documentation for calling
`fs.readFileSync` on a directory. The example was presumably copied from
the documentation for `fs.readFile`, which has an error argument in its
callback.

PR-URL: #20902
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
@not-an-aardvark
Copy link
Contributor Author

Landed in 5823938.

(The last CI at https://ci.nodejs.org/job/node-test-pull-request-lite/745/ passed, but didn't update the status on this PR for some reason.)

@not-an-aardvark not-an-aardvark deleted the fix-incorrect-fs-example branch May 23, 2018 04:37
targos pushed a commit that referenced this pull request May 25, 2018
This fixes an incorrect example in the documentation for calling
`fs.readFileSync` on a directory. The example was presumably copied from
the documentation for `fs.readFile`, which has an error argument in its
callback.

PR-URL: #20902
Reviewed-By: Anna Henningsen <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Rich Trott <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Trivikram Kamat <[email protected]>
@MylesBorins MylesBorins mentioned this pull request May 29, 2018
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.

8 participants