summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike McNeil <mikermcneil@users.noreply.github.com>2016-10-13 22:43:07 -0500
committerGitHub <noreply@github.com>2016-10-13 22:43:07 -0500
commit87185be19b01cc824e8ca3270d5516920d3c6e8e (patch)
tree5377f0958fda0af95fbacbebecb6df0107ea938e
parent7a252d05bca5e1cd8d6bb6ce2a70942806fe1a2f (diff)
downloadasync-87185be19b01cc824e8ca3270d5516920d3c6e8e.tar.gz
update docs for mapValuesLimit
same as https://github.com/caolan/async/pull/1304/commits/7a252d05bca5e1cd8d6bb6ce2a70942806fe1a2f but for `mapValuesLimit`
-rw-r--r--lib/mapValuesSeries.js5
1 files changed, 3 insertions, 2 deletions
diff --git a/lib/mapValuesSeries.js b/lib/mapValuesSeries.js
index b97fcd1..10c74ea 100644
--- a/lib/mapValuesSeries.js
+++ b/lib/mapValuesSeries.js
@@ -16,7 +16,8 @@ import doLimit from './internal/doLimit';
* once it has completed with an error (which can be `null`) and a
* transformed value. Invoked with (value, key, callback).
* @param {Function} [callback] - A callback which is called when all `iteratee`
- * functions have finished, or an error occurs. Result is an object of the
- * transformed values from the `obj`. Invoked with (err, result).
+ * functions have finished, or an error occurs. `result` is a new object consisting
+ * of each key from `obj`, with each transformed result on the right-hand side.
+ * Invoked with (err, result).
*/
export default doLimit(mapValuesLimit, 1);