summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAlexander Early <alexander.early@gmail.com>2016-05-05 16:42:34 -0700
committerAlexander Early <alexander.early@gmail.com>2016-05-05 16:42:34 -0700
commitdbba0215f19d980fcfa83fdcab631370dfb939bc (patch)
tree382d8f00c20e6634ccfabc389f29f6402dbfbedf /README.md
parent35a5f38770fb572db3a8c957055ac61812272a78 (diff)
downloadasync-dbba0215f19d980fcfa83fdcab631370dfb939bc.tar.gz
Clarify doWhilst/doUntil docs. Closes #1107
Diffstat (limited to 'README.md')
-rw-r--r--README.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/README.md b/README.md
index 80567f4..871f123 100644
--- a/README.md
+++ b/README.md
@@ -919,7 +919,7 @@ async.whilst(
### doWhilst(fn, test, callback)
The post-check version of [`whilst`](#whilst). To reflect the difference in
-the order of operations, the arguments `test` and `fn` are switched.
+the order of operations, the arguments `test` and `fn` are switched. The `test` function is also passed the non-error callback results of `fn`.
`doWhilst` is to `whilst` as `do while` is to `while` in plain JavaScript.
@@ -941,7 +941,7 @@ The inverse of [`whilst`](#whilst).
### doUntil(fn, test, callback)
-Like [`doWhilst`](#doWhilst), except the `test` is inverted. Note the argument ordering differs from `until`.
+Like [`doWhilst`](#doWhilst), except the `test` is inverted. Note the argument ordering differs from `until`. The `test` function is also passed the non-error callback results of `fn`.
---------------------------------------