doc: fs doc improvements #17831
Closed
doc: fs doc improvements #17831
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
vsemozhetbyt
approved these changes
Dec 23, 2017
doc/api/fs.md
Outdated
| fs.accessSyc('etc/passwd', fs.constants.R_OK | fs.constants.W_OK); | ||
| console.log('can read/write'); | ||
| } catch (err) { | ||
| console.log('no access!'); |
There was a problem hiding this comment.
A nit: maybe console.error('no access!')?
doc/api/fs.md
Outdated
|
|
||
| try { | ||
| fd = fs.openSync('message.txt', 'a'); | ||
| fs.appendFile(fd, 'data to append', 'utf8'); |
There was a problem hiding this comment.
appendFile -> appendFileSync
doc/api/fs.md
Outdated
| An easier method of constructing the `mode` is to use a sequence of three | ||
| octal digits (e.g. `765`). The left-most digit (`7` in the example), specifies | ||
| the permissions for the file owner. The middle digit (`6` in the example), | ||
| specifies permissions for the group. The right most digit (`5` in the example), |
There was a problem hiding this comment.
right most -> right-most ?
maclover7
reviewed
Dec 23, 2017
doc/api/fs.md
Outdated
|
|
||
| ```js | ||
| try { | ||
| fs.accessSyc('etc/passwd', fs.constants.R_OK | fs.constants.W_OK); |
There was a problem hiding this comment.
accessSyc --> accessSync
doc/api/fs.md
Outdated
| @@ -846,10 +870,21 @@ If `options` is a string, then it specifies the encoding. Example: | |||
| fs.appendFile('message.txt', 'data to append', 'utf8', callback); | |||
| ``` | |||
|
|
|||
| Any specified file descriptor has to have been opened for appending. | |||
| The `file` may be specified as a numeric file descriptor that has been opened | |||
| for appending (using `fs.open()` or `fs.openSync()`. It is important to note | |||
There was a problem hiding this comment.
needs closing parenthesis after openSync()
There was a problem hiding this comment.
+ The same for fs.appendFileSync() note.
Trott
reviewed
Dec 23, 2017
doc/api/fs.md
Outdated
|
|
||
| The `file` may be specified as a numeric file descriptor that has been opened | ||
| for appending (using `fs.open()` or `fs.openSync()`. It is important to note | ||
| that the file descriptor will not be closed automatically. |
There was a problem hiding this comment.
Suggestion: It is important to note that the file descriptor will not be closed automatically. -> The file descriptor will not be closed automatically.
Trott
reviewed
Dec 23, 2017
doc/api/fs.md
Outdated
| Any specified file descriptor has to have been opened for appending. | ||
| The `file` may be specified as a numeric file descriptor that has been opened | ||
| for appending (using `fs.open()` or `fs.openSync()`. It is important to note | ||
| that the file descriptor will not be closed automatically. |
There was a problem hiding this comment.
Suggestion: It is important to note that the file descriptor will not be closed automatically. -> The file descriptor will not be closed automatically.
lpinca
approved these changes
Dec 26, 2017
starkwang
added
the
author ready
|
@jasnell CI seems failed: |
jasnell
added a commit
that referenced
this pull request
Dec 28, 2017
PR-URL: #17831 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
|
Landed in 286a5d0 |
addaleax
removed
the
author ready
MylesBorins
pushed a commit
that referenced
this pull request
Jan 8, 2018
PR-URL: #17831 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
MylesBorins
pushed a commit
that referenced
this pull request
Jan 9, 2018
PR-URL: #17831 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
MylesBorins
pushed a commit
that referenced
this pull request
Jan 9, 2018
PR-URL: #17831 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
Merged
gibfahn
pushed a commit
that referenced
this pull request
Jan 24, 2018
PR-URL: #17831 Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
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.
Some fs doc improvements
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)
doc