doc: remove "note that" from fs doc #21646
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
doc
trivikr
approved these changes
Jul 4, 2018
ChALkeR
approved these changes
Jul 4, 2018
doc/api/fs.md
Outdated
| a callback.) | ||
| `fs.exists()` is deprecated, but `fs.existsSync()` is not. (The `callback` | ||
| parameter to `fs.exists()` accepts parameters that are inconsistent with other | ||
| Node.js callbacks. `fs.existsSync()` does not use a callback.) |
There was a problem hiding this comment.
Nit: I don't think brackets around the last sentance are needed, also.
doc/api/fs.md
Outdated
| @@ -2149,7 +2145,7 @@ fs.mkdtemp(tmpDir, (err, folder) => { | |||
| if (err) throw err; | |||
| console.log(folder); | |||
| // Will print something similar to `/tmpabc123`. | |||
| // Note that a new temporary directory is created | |||
| // A new temporary directory is created | |||
There was a problem hiding this comment.
Nit: can fit on three lines:
// Will print something similar to `/tmpabc123`.
// A new temporary directory is created at the file system root
// rather than *within* the /tmp directory.There was a problem hiding this comment.
Wrapped and reduced to 3 lines. Thanks.
cjihrig
approved these changes
Jul 4, 2018
vsemozhetbyt
reviewed
Jul 4, 2018
doc/api/fs.md
Outdated
| Note that it is unsafe to use `fs.write` multiple times on the same file | ||
| without waiting for the callback. For this scenario, | ||
| `fs.createWriteStream` is strongly recommended. | ||
| It is unsafe to use `fs.write` multiple times on the same file without waiting |
There was a problem hiding this comment.
`fs.write` -> `fs.write()`?
There was a problem hiding this comment.
This and the other similar nit below addressed. Thanks!
vsemozhetbyt
reviewed
Jul 4, 2018
doc/api/fs.md
Outdated
| Note that it is unsafe to use `fs.write` multiple times on the same file | ||
| without waiting for the callback. For this scenario, | ||
| `fs.createWriteStream` is strongly recommended. | ||
| It is unsafe to use `fs.write` multiple times on the same file without waiting |
There was a problem hiding this comment.
`fs.write` -> `fs.write()`?
vsemozhetbyt
approved these changes
Jul 4, 2018
lpinca
approved these changes
Jul 4, 2018
Remove "note that" from the fs documentation, along with other minor
nearby improvements.
Before:
Note that some characters are obscured by Strong Bad's head.
After:
Some characters are obscured by Strong Bad's head.
Trott
added
the
author ready
|
Landed in f545ae9 |
Trott
added a commit
to Trott/io.js
that referenced
this pull request
Jul 6, 2018
Remove "note that" from the fs documentation, along with other minor
nearby improvements.
Before:
Note that some characters are obscured by Strong Bad's head.
After:
Some characters are obscured by Strong Bad's head.
PR-URL: nodejs#21646
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
targos
pushed a commit
that referenced
this pull request
Jul 6, 2018
Remove "note that" from the fs documentation, along with other minor
nearby improvements.
Before:
Note that some characters are obscured by Strong Bad's head.
After:
Some characters are obscured by Strong Bad's head.
PR-URL: #21646
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Сковорода Никита Андреевич <chalkerx@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Merged
This was referenced Jul 18, 2018
2 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Remove "note that" from the fs documentation, along with other minor
nearby improvements.
Before:
After:
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes