summaryrefslogtreecommitdiff
path: root/lib/parallelLimit.js
diff options
context:
space:
mode:
authorHubert Argasinski <argasinski.hubert@gmail.com>2016-06-29 01:35:29 -0400
committerHubert Argasinski <argasinski.hubert@gmail.com>2016-06-29 01:56:11 -0400
commit7eaa3b3a9bee0df38ebc0b640a97de42ca05d5da (patch)
tree942b9ea5e9a18f7f55fd01c51555d0c01f82fc5e /lib/parallelLimit.js
parent90c4f893a30044b67d48a62e42d2c42f379a822f (diff)
downloadasync-7eaa3b3a9bee0df38ebc0b640a97de42ca05d5da.tar.gz
jsdocs: using proxy modules as categories, modifying minami theme
jsdocs: style fix in outputted html jsdoc: added documentation to support script
Diffstat (limited to 'lib/parallelLimit.js')
-rw-r--r--lib/parallelLimit.js11
1 files changed, 7 insertions, 4 deletions
diff --git a/lib/parallelLimit.js b/lib/parallelLimit.js
index d313bb8..7057bd0 100644
--- a/lib/parallelLimit.js
+++ b/lib/parallelLimit.js
@@ -2,14 +2,17 @@ import eachOfLimit from './internal/eachOfLimit';
import parallel from './internal/parallel';
/**
- * The same as `parallel` but runs a maximum of `limit` async operations at a
+ * ```
+ * import parallelLimit from 'async/parallelLimit'
+ * ```
+ * The same as [`parallel`]{@link module:ControlFlow.parallel} but runs a maximum of `limit` async operations at a
* time.
*
- * @name parallel
+ * @name parallelLimit
* @static
- * @memberOf module:async
+ * @memberOf module:ControlFlow
* @method
- * @see [async.parallel]{@link module:async.parallel}
+ * @see [async.parallel]{@link module:ControlFlow.parallel}
* @category Control Flow
* @param {Array|Collection} tasks - A collection containing functions to run.
* Each function is passed a `callback(err, result)` which it must call on