Document all create*() aliases for ensure*() methods

Fixes #758
jprichardson · Feb 24, 2020 · ba7a36f · ba7a36f
1 parent ab92b24
commit ba7a36f
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 0 deletions.
diff --git a/docs/ensureLink-sync.md b/docs/ensureLink-sync.md
@@ -2,6 +2,8 @@
 
 Ensures that the link exists. If the directory structure does not exist, it is created.
 
+**Alias:** `createLinkSync()`
+
 - `srcpath` `<String>`
 - `dstpath` `<String>`
 

diff --git a/docs/ensureLink.md b/docs/ensureLink.md
@@ -2,6 +2,8 @@
 
 Ensures that the link exists. If the directory structure does not exist, it is created.
 
+**Alias:** `createLink()`
+
 - `srcpath` `<String>`
 - `dstpath` `<String>`
 - `callback` `<Function>`

diff --git a/docs/ensureSymlink-sync.md b/docs/ensureSymlink-sync.md
@@ -2,6 +2,8 @@
 
 Ensures that the symlink exists. If the directory structure does not exist, it is created.
 
+**Alias:** `createSymlinkSync()`
+
 - `srcpath` `<String>`
 - `dstpath` `<String>`
 - `type` `<String>`

diff --git a/docs/ensureSymlink.md b/docs/ensureSymlink.md
@@ -2,6 +2,8 @@
 
 Ensures that the symlink exists. If the directory structure does not exist, it is created.
 
+**Alias:** `createSymlink()`
+
 - `srcpath` `<String>`
 - `dstpath` `<String>`
 - `type` `<String>`