[Pkg-javascript-commits] [node-async] 434/480: improve `.auto` docs

[Jonas Smedegaard]

This is an automated email from the git hooks/post-receive script.

js pushed a commit to branch master
in repository node-async.

commit d7efd38a0cb82f7220703b6f2c38b5dde9a8361e
Author: Mithgol <getgit at mithgol.ru>
Date:   Sun Mar 30 22:55:50 2014 -0700

    improve `.auto` docs
---
 README.md | 9 +++++----
 1 file 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.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-async.git