summaryrefslogtreecommitdiff
path: root/doc/api/fs.md
diff options
context:
space:
mode:
authorRich Trott <rtrott@gmail.com>2019-06-02 11:20:48 +0200
committerRich Trott <rtrott@gmail.com>2019-06-02 11:25:59 +0200
commite7ca3987a2d88cee3523abe72e38f1ddc6cb13db (patch)
tree7653651d6ce7bd20b58e755ee73a44980ebee633 /doc/api/fs.md
parent5539d7e360a625e729a4f95e67d232d3400fc137 (diff)
downloadandroid-node-v8-e7ca3987a2d88cee3523abe72e38f1ddc6cb13db.tar.gz
android-node-v8-e7ca3987a2d88cee3523abe72e38f1ddc6cb13db.tar.bz2
android-node-v8-e7ca3987a2d88cee3523abe72e38f1ddc6cb13db.zip
doc: improve explanation for directory with fs.rename()
PR-URL: https://github.com/nodejs/node/pull/27963 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Yongsheng Zhang <zyszys98@gmail.com>
Diffstat (limited to 'doc/api/fs.md')
-rw-r--r--doc/api/fs.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/api/fs.md b/doc/api/fs.md
index 581af57403..d2506d28e3 100644
--- a/doc/api/fs.md
+++ b/doc/api/fs.md
@@ -2898,7 +2898,8 @@ changes:
Asynchronously rename file at `oldPath` to the pathname provided
as `newPath`. In the case that `newPath` already exists, it will
-be overwritten. No arguments other than a possible exception are
+be overwritten. If there is a directory at `newPath`, an error will
+be raised instead. No arguments other than a possible exception are
given to the completion callback.
See also: rename(2).