doc: update behaviour of fs.writeFile

As per the decision in #23433, the `fs.writeFile` will always write from the current position if it is used with file descriptors. This patch updates it. Ref: #23709 PR-URL: #25080 Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: Weijia Wang <[email protected]> Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Anto Aravinth <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]> Reviewed-By: Rod Vagg <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
nodejs · Jan 7, 2019 · 309e772 · 309e772
1 parent 0066fdb
commit 309e772
Showing 1 changed file with 4 additions and 4 deletions.
diff --git a/doc/api/fs.md b/doc/api/fs.md
@@ -3614,10 +3614,10 @@ recommended.
 1. Any specified file descriptor has to support writing.
 2. If a file descriptor is specified as the `file`, it will not be closed
 automatically.
-3. The writing will begin at the beginning of the file. For example, if the
-file already had `'Hello World'` and the newly written content is `'Aloha'`,
-then the contents of the file would be `'Aloha World'`, rather than just
-`'Aloha'`.
+3. The writing will begin at the current position. For example, if the string
+`'Hello'` is written to the file descriptor, and if `', World'` is written with
+`fs.writeFile()` to the same file descriptor, the contents of the file would
+become `'Hello, World'`, instead of just `', World'`.
 
 
 ## fs.writeFileSync(file, data[, options])