Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorvipul kumar <vipulkumar532532@gmil.com>2021-09-04 09:36:59 +0300
committerMichaƫl Zasso <targos@protonmail.com>2021-09-18 17:09:31 +0300
commitf4292bc17b4611c8d86ee2329494a49562b6498f (patch)
treef179645a341e8c401fafa8fadbe31133308fc206 /doc
parent8900a4663f45d047894b98875f58529f6026746e (diff)
doc: correct parameters in fs and stream documentation
PR-URL: https://github.com/nodejs/node/pull/39984 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/fs.md4
-rw-r--r--doc/api/stream.md2
2 files changed, 3 insertions, 3 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md
index 5f713cc6060..e3aa603dc5a 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -2680,7 +2680,7 @@ changes:
Asynchronously creates a directory.
The callback is given a possible exception and, if `recursive` is `true`, the
-first directory path created, `(err, [path])`.
+first directory path created, `(err[, path])`.
`path` can still be `undefined` when `recursive` is `true`, if no directory was
created.
@@ -4908,7 +4908,7 @@ Returns the number of `bytesRead`.
For detailed information, see the documentation of the asynchronous version of
this API: [`fs.read()`][].
-### `fs.readSync(fd, buffer, [options])`
+### `fs.readSync(fd, buffer[, options])`
<!-- YAML
added:
- v13.13.0
diff --git a/doc/api/stream.md b/doc/api/stream.md
index f874338b23e..b3b1f628b3a 100644
--- a/doc/api/stream.md
+++ b/doc/api/stream.md
@@ -2041,7 +2041,7 @@ await finished(compose(s1, s2, s3));
console.log(res); // prints 'HELLOWORLD'
```
-### `stream.Readable.from(iterable, [options])`
+### `stream.Readable.from(iterable[, options])`
<!-- YAML
added:
- v12.3.0