From fab376ec2bd4d4420806644c1b37a7ac487d17ec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jan=20Peer=20St=C3=B6cklmair?= Date: Fri, 12 Jan 2018 00:02:18 +0100 Subject: [PATCH] Docs: add copy note for src (#538) --- docs/copy-sync.md | 4 ++-- docs/copy.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/copy-sync.md b/docs/copy-sync.md index 0a33e47..ac64807 100644 --- a/docs/copy-sync.md +++ b/docs/copy-sync.md @@ -2,8 +2,8 @@ Copy a file or directory. The directory can have contents. Like `cp -r`. -- `src` `` -- `dest` `` +- `src` `` Note that if `src` is a directory it will copy everything inside of this directory, not the entire directory itself (see [issue #537](https://github.com/jprichardson/node-fs-extra/issues/537)). +- `dest` `` Note that if `src` is a file, `dest` cannot be a directory (see [issue #323](https://github.com/jprichardson/node-fs-extra/issues/323)). - `options` `` - `overwrite` ``: overwrite existing file or directory, default is `true`. _Note that the copy operation will silently fail if you set this to `false` and the destination exists._ Use the `errorOnExist` option to change this behavior. - `errorOnExist` ``: when `overwrite` is `false` and the destination exists, throw an error. Default is `false`. diff --git a/docs/copy.md b/docs/copy.md index 23fffaf..d0f78a9 100644 --- a/docs/copy.md +++ b/docs/copy.md @@ -2,7 +2,7 @@ Copy a file or directory. The directory can have contents. Like `cp -r`. -- `src` `` +- `src` `` Note that if `src` is a directory it will copy everything inside of this directory, not the entire directory itself (see [issue #537](https://github.com/jprichardson/node-fs-extra/issues/537)). - `dest` `` Note that if `src` is a file, `dest` cannot be a directory (see [issue #323](https://github.com/jprichardson/node-fs-extra/issues/323)). - `options` `` - `overwrite` ``: overwrite existing file or directory, default is `true`. _Note that the copy operation will silently fail if you set this to `false` and the destination exists._ Use the `errorOnExist` option to change this behavior.