diff options
| author | Tim Ruffles <timruffles@googlemail.com> | 2018-07-11 10:10:42 +0100 |
|---|---|---|
| committer | Vse Mozhet Byt <vsemozhetbyt@gmail.com> | 2018-07-21 16:24:31 +0300 |
| commit | 2d48f97ddda4fce9a03397c89ab5dc329280e9ed (patch) | |
| tree | 748b5ef5745d1236e3db1c1748822028f4409f43 /doc | |
| parent | 2058a1c35a1431540561584185c0f0b2410291b6 (diff) | |
| download | android-node-v8-2d48f97ddda4fce9a03397c89ab5dc329280e9ed.tar.gz android-node-v8-2d48f97ddda4fce9a03397c89ab5dc329280e9ed.tar.bz2 android-node-v8-2d48f97ddda4fce9a03397c89ab5dc329280e9ed.zip | |
doc: fix descriptions of sync methods in fs.md
PR-URL: https://github.com/nodejs/node/pull/21747
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jon Moss <me@jonathanmoss.me>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/fs.md | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md index 282b2ddaec..d0348d45c9 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -2336,7 +2336,7 @@ Synchronous readdir(3). The optional `options` argument can be a string specifying an encoding, or an object with an `encoding` property specifying the character encoding to use for -the filenames passed to the callback. If the `encoding` is set to `'buffer'`, +the filenames returned. If the `encoding` is set to `'buffer'`, the filenames returned will be passed as `Buffer` objects. ## fs.readFile(path[, options], callback) @@ -2508,7 +2508,7 @@ Synchronous readlink(2). Returns the symbolic link's string value. The optional `options` argument can be a string specifying an encoding, or an object with an `encoding` property specifying the character encoding to use for -the link path passed to the callback. If the `encoding` is set to `'buffer'`, +the link path returned. If the `encoding` is set to `'buffer'`, the link path returned will be passed as a `Buffer` object. ## fs.readSync(fd, buffer, offset, length, position) @@ -2666,7 +2666,7 @@ Only paths that can be converted to UTF8 strings are supported. The optional `options` argument can be a string specifying an encoding, or an object with an `encoding` property specifying the character encoding to use for -the path passed to the callback. If the `encoding` is set to `'buffer'`, +the path returned. If the `encoding` is set to `'buffer'`, the path returned will be passed as a `Buffer` object. On Linux, when Node.js is linked against musl libc, the procfs file system must |