diff options
author | Alexander Early <alexander.early@gmail.com> | 2017-04-01 15:05:52 -0700 |
---|---|---|
committer | Alexander Early <alexander.early@gmail.com> | 2017-04-01 15:05:52 -0700 |
commit | 94a8b2d18bf10cca67cf4c308253f642bbb2b160 (patch) | |
tree | 001afe9b92618fe3ce75e7bdd0979e59ee0a8d63 /lib/auto.js | |
parent | faf395c546747c2066e673405e0aec94362811a0 (diff) | |
download | async-94a8b2d18bf10cca67cf4c308253f642bbb2b160.tar.gz |
use the AsyncFunction type in all docs :sweat:
Diffstat (limited to 'lib/auto.js')
-rw-r--r-- | lib/auto.js | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/lib/auto.js b/lib/auto.js index 4d7bf32..ba0fdc3 100644 --- a/lib/auto.js +++ b/lib/auto.js @@ -11,17 +11,17 @@ import onlyOnce from './internal/onlyOnce'; import wrapAsync from './internal/wrapAsync'; /** - * Determines the best order for running the functions in `tasks`, based on + * Determines the best order for running the {@link AsyncFunction}s in `tasks`, based on * their requirements. Each function can optionally depend on other functions * being completed first, and each function is run as soon as its requirements * are satisfied. * - * If any of the functions pass an error to their callback, the `auto` sequence + * If any of the {@link AsyncFunction}s pass an error to their callback, the `auto` sequence * will stop. Further tasks will not execute (so any other functions depending * on it will not run), and the main `callback` is immediately called with the * error. * - * Functions also receive an object containing the results of functions which + * {@link AsyncFunction}s also receive an object containing the results of functions which * have completed so far as the first argument, if they have dependencies. If a * task function has no dependencies, it will only be passed a callback. * @@ -31,7 +31,7 @@ import wrapAsync from './internal/wrapAsync'; * @method * @category Control Flow * @param {Object} tasks - An object. Each of its properties is either a - * function or an array of requirements, with the function itself the last item + * function or an array of requirements, with the {@link AsyncFunction} itself the last item * in the array. The object's key of a property serves as the name of the task * defined by that property, i.e. can be used when specifying requirements for * other tasks. The function receives one or two arguments: |