summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCaolan McMahon <caolan.mcmahon@gmail.com>2014-03-31 10:51:37 +0100
committerCaolan McMahon <caolan.mcmahon@gmail.com>2014-03-31 10:51:37 +0100
commitd0850b7e99fa2271991c465d7439f4a1560e8980 (patch)
tree0a3b33ce0458b26a4b843e1ac21fab86b88c9bc1
parent6f6885fdc16315215a9e380199a4b7c0b6b83958 (diff)
parentd7efd38a0cb82f7220703b6f2c38b5dde9a8361e (diff)
downloadasync-d0850b7e99fa2271991c465d7439f4a1560e8980.tar.gz
Merge pull request #481 from Mithgol/improve-auto-docs
improve `.auto` docs
-rw-r--r--README.md9
1 files changed, 5 insertions, 4 deletions
diff --git a/README.md b/README.md
index de34420..1a85777 100644
--- a/README.md
+++ b/README.md
@@ -1242,10 +1242,11 @@ async.auto({
__Arguments__
-* `tasks` - An object literal (containing named functions) or an array (of
- requirements, with the function itself the last item in the array). The key
- used for each function or array is used when specifying requirements. The
- function receives two arguments: (1) a `callback(err, result)` which must be
+* `tasks` - An object. Each of its properties is either a function or an array of
+ requirements, with the function itself the last item in the array. The object's key
+ of a property serves as the name of the task defined by that property,
+ i.e. can be used when specifying requirements for other tasks.
+ The function receives two arguments: (1) a `callback(err, result)` which must be
called when finished, passing an `error` (which can be `null`) and the result of
the function's execution, and (2) a `results` object, containing the results of
the previously executed functions.