From eabe907e03e47e585aa2a1ac04e398d70e3539a7 Mon Sep 17 00:00:00 2001 From: Tim Ruffles Date: Wed, 11 Jul 2018 10:10:42 +0100 Subject: [PATCH] doc: fix descriptions of sync methods in fs.md PR-URL: https://github.com/nodejs/node/pull/21747 Reviewed-By: Anna Henningsen Reviewed-By: Luigi Pinca Reviewed-By: Jon Moss Reviewed-By: James M Snell Reviewed-By: Vse Mozhet Byt Reviewed-By: Colin Ihrig Reviewed-By: Ruben Bridgewater Reviewed-By: Trivikram Kamat --- doc/api/fs.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/api/fs.md b/doc/api/fs.md index dafda61124ec00..57aabee7035fe7 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -2331,7 +2331,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) @@ -2503,7 +2503,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) @@ -2661,7 +2661,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