summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorKenta Fried <kenta.fried@gmail.com>2015-12-02 11:44:04 -0800
committerKenta Fried <kenta.fried@gmail.com>2015-12-02 11:44:04 -0800
commit0469948b230196bdb4e8e51e0df50853ad2d0d17 (patch)
tree3c645377b75743f6ab940255fb72b0ba410e863b /README.md
parenta92b163ec46e36eef828c620543aa88e95c48b1f (diff)
downloadasync-0469948b230196bdb4e8e51e0df50853ad2d0d17.tar.gz
Bug fix #968: uddate Readme for `async.every()`
Diffstat (limited to 'README.md')
-rw-r--r--README.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/README.md b/README.md
index 2a80bf1..6c9b5eb 100644
--- a/README.md
+++ b/README.md
@@ -627,9 +627,9 @@ __Arguments__
* `iterator(item, callback)` - A truth test to apply to each item in the array
in parallel. The iterator is passed a `callback(truthValue)` which must be
called with a boolean argument once it has completed.
-* `callback(result)` - *Optional* A callback which is called after all the `iterator`
- functions have finished. Result will be either `true` or `false` depending on
- the values of the async tests.
+* `callback(result)` - *Optional* A callback which is called as soon as any iterator returns
+ `true`, or after all the iterator functions have finished. Result will be
+ either `true` or `false` depending on the values of the async tests.
**Note: the callbacks do not take an error as their first argument.**