Skip to content

Commit 2d48f97

Browse files
timrufflesvsemozhetbyt
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 2058a1c commit 2d48f97

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
@@ -2336,7 +2336,7 @@ Synchronous readdir(3).
23362336

23372337
The optional `options` argument can be a string specifying an encoding, or an
23382338
object with an `encoding` property specifying the character encoding to use for
2339-
the filenames passed to the callback. If the `encoding` is set to `'buffer'`,
2339+
the filenames returned. If the `encoding` is set to `'buffer'`,
23402340
the filenames returned will be passed as `Buffer` objects.
23412341

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

25092509
The optional `options` argument can be a string specifying an encoding, or an
25102510
object with an `encoding` property specifying the character encoding to use for
2511-
the link path passed to the callback. If the `encoding` is set to `'buffer'`,
2511+
the link path returned. If the `encoding` is set to `'buffer'`,
25122512
the link path returned will be passed as a `Buffer` object.
25132513

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

26672667
The optional `options` argument can be a string specifying an encoding, or an
26682668
object with an `encoding` property specifying the character encoding to use for
2669-
the path passed to the callback. If the `encoding` is set to `'buffer'`,
2669+
the path returned. If the `encoding` is set to `'buffer'`,
26702670
the path returned will be passed as a `Buffer` object.
26712671

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

0 commit comments

Comments
 (0)