Fix doc comment for exported rmRF function (#616)

microsoft · Jan 28, 2020 · 2e3cdea · 2e3cdea
1 parent 7f62b8a
commit 2e3cdea
Showing 1 changed file with 2 additions and 3 deletions.
diff --git a/node/task.ts b/node/task.ts
@@ -1146,10 +1146,9 @@ function _legacyFindFiles_getMatchingItems(
 
 /**
  * Remove a path recursively with force
- * Returns whether it succeeds
  * 
- * @param     path     path to remove
- * @returns   void
+ * @param     inputPath path to remove
+ * @throws    when the file or directory exists but could not be deleted.
  */
 export function rmRF(inputPath: string): void {
     debug('rm -rf ' + inputPath);