Skip to content

Commit eabe907

Browse files
timrufflestargos
authored andcommitted
doc: fix descriptions of sync methods in fs.md
PR-URL: #21747 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Jon Moss <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
1 parent 8191563 commit eabe907

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/api/fs.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2331,7 +2331,7 @@ Synchronous readdir(3).
23312331

23322332
The optional `options` argument can be a string specifying an encoding, or an
23332333
object with an `encoding` property specifying the character encoding to use for
2334-
the filenames passed to the callback. If the `encoding` is set to `'buffer'`,
2334+
the filenames returned. If the `encoding` is set to `'buffer'`,
23352335
the filenames returned will be passed as `Buffer` objects.
23362336

23372337
## fs.readFile(path[, options], callback)
@@ -2503,7 +2503,7 @@ Synchronous readlink(2). Returns the symbolic link's string value.
25032503

25042504
The optional `options` argument can be a string specifying an encoding, or an
25052505
object with an `encoding` property specifying the character encoding to use for
2506-
the link path passed to the callback. If the `encoding` is set to `'buffer'`,
2506+
the link path returned. If the `encoding` is set to `'buffer'`,
25072507
the link path returned will be passed as a `Buffer` object.
25082508

25092509
## fs.readSync(fd, buffer, offset, length, position)
@@ -2661,7 +2661,7 @@ Only paths that can be converted to UTF8 strings are supported.
26612661

26622662
The optional `options` argument can be a string specifying an encoding, or an
26632663
object with an `encoding` property specifying the character encoding to use for
2664-
the path passed to the callback. If the `encoding` is set to `'buffer'`,
2664+
the path returned. If the `encoding` is set to `'buffer'`,
26652665
the path returned will be passed as a `Buffer` object.
26662666

26672667
On Linux, when Node.js is linked against musl libc, the procfs file system must

0 commit comments

Comments
 (0)