From 938de338ef609fa7381bfb9f06d256f0f3b85bc1 Mon Sep 17 00:00:00 2001
From: James M Snell <jasnell@gmail.com>
Date: Fri, 3 Jul 2020 13:03:56 -0700
Subject: [PATCH] doc: specify how fs.WriteStream/ReadStreams are created

Alternative to https://github.com/nodejs/node/pull/33841

Co-authored-by: zombieleet <zombieleetnca@gmail.com>

PR-URL: https://github.com/nodejs/node/pull/34188
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
---
 doc/api/fs.md | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/doc/api/fs.md b/doc/api/fs.md
index d64b011147d510..f7014ec7c7d9c3 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -654,8 +654,8 @@ added: v0.1.93
 
 * Extends: {stream.Readable}
 
-A successful call to `fs.createReadStream()` will return a new `fs.ReadStream`
-object.
+Instances of `fs.ReadStream` are created and returned using the
+[`fs.createReadStream()`][] function.
 
 ### Event: `'close'`
 <!-- YAML
@@ -1079,6 +1079,9 @@ added: v0.1.93
 
 * Extends {stream.Writable}
 
+Instances of `fs.WriteStream` are created and returned using the
+[`fs.createWriteStream()`][] function.
+
 ### Event: `'close'`
 <!-- YAML
 added: v0.1.93
@@ -5874,6 +5877,7 @@ the file contents.
 [`fs.chmod()`]: #fs_fs_chmod_path_mode_callback
 [`fs.chown()`]: #fs_fs_chown_path_uid_gid_callback
 [`fs.copyFile()`]: #fs_fs_copyfile_src_dest_mode_callback
+[`fs.createReadStream()`]: #fs_fs_createreadstream_path_options
 [`fs.createWriteStream()`]: #fs_fs_createwritestream_path_options
 [`fs.exists()`]: fs.html#fs_fs_exists_path_callback
 [`fs.fstat()`]: #fs_fs_fstat_fd_options_callback