Skip to content

Commit

Permalink
Merge pull request #1280 from hairyhenderson/fix-whilst-doc-inconsist…
Browse files Browse the repository at this point in the history
…ency

Fixing inconsistency in whilst jsdoc
  • Loading branch information
aearly committed Sep 9, 2016
2 parents f49d94f + 18b7516 commit 166b856
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions lib/whilst.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import rest from 'lodash/_baseRest';
import onlyOnce from './internal/onlyOnce';

/**
* Repeatedly call `fn`, while `test` returns `true`. Calls `callback` when
* Repeatedly call `iteratee`, while `test` returns `true`. Calls `callback` when
* stopped, or an error occurs.
*
* @name whilst
Expand All @@ -13,13 +13,13 @@ import onlyOnce from './internal/onlyOnce';
* @method
* @category Control Flow
* @param {Function} test - synchronous truth test to perform before each
* execution of `fn`. Invoked with ().
* execution of `iteratee`. Invoked with ().
* @param {Function} iteratee - A function which is called each time `test` passes.
* The function is passed a `callback(err)`, which must be called once it has
* completed with an optional `err` argument. Invoked with (callback).
* @param {Function} [callback] - A callback which is called after the test
* function has failed and repeated execution of `fn` has stopped. `callback`
* will be passed an error and any arguments passed to the final `fn`'s
* function has failed and repeated execution of `iteratee` has stopped. `callback`
* will be passed an error and any arguments passed to the final `iteratee`'s
* callback. Invoked with (err, [results]);
* @returns undefined
* @example
Expand Down

0 comments on commit 166b856

Please sign in to comment.