summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDavid Beck <david@rotundasoftware.com>2013-08-14 12:04:20 -0700
committerCaolan McMahon <caolan@caolanmcmahon.com>2014-03-28 15:26:19 +0000
commitd1fd53116dfd55d236ac7a305f0dc915d8cda145 (patch)
tree527484f8941c352c390f829c8f339a6034cdb86f
parentde3aae25a92b6a64317337ea4d9f1c91f0ad011c (diff)
downloadasync-d1fd53116dfd55d236ac7a305f0dc915d8cda145.tar.gz
Clarify that `some` and `every` run iterators in parallel in readme
-rw-r--r--README.md12
1 files changed, 6 insertions, 6 deletions
diff --git a/README.md b/README.md
index c6130ff..cc19c6e 100644
--- a/README.md
+++ b/README.md
@@ -543,9 +543,9 @@ call returns `true`, the main `callback` is immediately called.
__Arguments__
* `arr` - An array to iterate over.
-* `iterator(item, callback)` - A truth test to apply to each item in `arr`.
- The iterator is passed a `callback(truthValue)` which must be called with a
- boolean argument once it has completed.
+* `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)` - 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.
@@ -573,9 +573,9 @@ way node libraries work with truth tests like `fs.exists`.
__Arguments__
* `arr` - An array to iterate over.
-* `iterator(item, callback)` - A truth test to apply to each item in `arr`.
- The `iterator` is passed a `callback(truthValue)` which must be called with a
- boolean argument once it has completed.
+* `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)` - 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.