Clarify move*() docs (#888)

Fixes #830
jprichardson · Apr 17, 2021 · ce29957 · ce29957
1 parent af35401
commit ce29957
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/move-sync.md b/docs/move-sync.md
@@ -3,7 +3,7 @@
 Moves a file or directory, even across devices.
 
 - `src` `<String>`
-- `dest` `<String>`
+- `dest` `<String>` Note: When `src` is a file, `dest` must be a file and when `src` is a directory, `dest` must be a directory.
 - `options` `<Object>`
   - `overwrite` `<boolean>`: overwrite existing file or directory, default is `false`.
 

diff --git a/docs/move.md b/docs/move.md
@@ -3,7 +3,7 @@
 Moves a file or directory, even across devices.
 
 - `src` `<String>`
-- `dest` `<String>`
+- `dest` `<String>` Note: When `src` is a file, `dest` must be a file and when `src` is a directory, `dest` must be a directory.
 - `options` `<Object>`
   - `overwrite` `<boolean>`: overwrite existing file or directory, default is `false`.
 - `callback` `<Function>`