[Pkg-javascript-commits] [node-async] 295/480: Merge pull request #240 from brianmaissy/documentation

[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 4a8099777ec6a5bc1d6fc1a2060cfb651bbd4ccc
Merge: f429d9b 4bd3684
Author: Caolan McMahon <caolan at caolanmcmahon.com>
Date:   Sat Mar 2 13:41:01 2013 -0800

    Merge pull request #240 from brianmaissy/documentation
    
    added a cautionary note to the documentation of async.auto

 README.md | 35 ++++++++++++++++++++++++++++++++---
 1 file changed, 32 insertions(+), 3 deletions(-)

diff --cc README.md
index 380ff31,e1178a1..6a9fb0b
--- a/README.md
+++ b/README.md
@@@ -981,15 -1009,14 +1009,16 @@@ __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 takes as an argument 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. 
+   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.
  * callback(err, results) - An optional callback which is called when all the
    tasks have been completed. The callback will receive an error as an argument
 -  if any tasks pass an error to their callback. If all tasks complete
 -  successfully, it will receive an object containing their results.
 +  if any tasks pass an error to their callback. Results will always be passed
 +	but if an error occurred, no other tasks will be performed, and the results
 +	object will only contain partial results.
 +  
  
  __Example__
  

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