Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix doc linking (see #1135) #1138

Merged
merged 1 commit into from
Apr 29, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/applyEachSeries.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import mapSeries from './mapSeries';
* @name applyEachSeries
* @static
* @memberOf async
* @see `async.applyEach`
* @see async.applyEach
* @category Control Flow
* @param {Array|Object} fns - A collection of asynchronous functions to all
* call with the same arguments
Expand Down
6 changes: 3 additions & 3 deletions lib/autoInject.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ function parseParams(func) {
}

/**
* A dependency-injected version of the [`auto`](#auto) function. Dependent
* A dependency-injected version of the {@link async.auto} function. Dependent
* tasks are specified as parameters to the function, after the usual callback
* parameter, with the parameter names matching the names of the tasks it
* depends on. This can provide even more readable task graphs which can be
Expand All @@ -21,12 +21,12 @@ function parseParams(func) {
* specified as named parameters after the initial error parameter.
*
* The autoInject function is purely syntactic sugar and its semantics are
* otherwise equivalent to [`auto`](#auto).
* otherwise equivalent to {@link async.auto}.
*
* @name autoInject
* @static
* @memberOf async
* @see `async.auto`
* @see async.auto
* @category Control Flow
* @param {Object} tasks - An object, each of whose properties is a function of
* the form 'func([dependencies...], callback). The object's key of a property
Expand Down
4 changes: 2 additions & 2 deletions lib/cargo.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import queue from './internal/queue';

/**
* A cargo of tasks for the worker function to complete. Cargo inherits all of
* the same methods and event callbacks as [`queue`](#queue).
* the same methods and event callbacks as {@link async.queue}.
* @typedef {Object} cargo
* @property {Function} length - A function returning the number of items
* waiting to be processed. Invoke with ().
Expand Down Expand Up @@ -46,7 +46,7 @@ import queue from './internal/queue';
* @name cargo
* @static
* @memberOf async
* @see `async.queue`
* @see async.queue
* @category Control Flow
* @param {Function} worker - An asynchronous function for processing an array
* of queued tasks, which must call its `callback(err)` argument when finished,
Expand Down
2 changes: 1 addition & 1 deletion lib/concatSeries.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import doSeries from './internal/doSeries';
* @name concatSeries
* @static
* @memberOf async
* @see `async.concat`
* @see async.concat
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
* @param {Function} iteratee - A function to apply to each item in `coll`.
Expand Down
2 changes: 1 addition & 1 deletion lib/detectLimit.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import findGetResult from './internal/findGetResult';
* @name detectLimit
* @static
* @memberOf async
* @see `async.detect`
* @see async.detect
* @alias findLimit
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
Expand Down
2 changes: 1 addition & 1 deletion lib/detectSeries.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import findGetResult from './internal/findGetResult';
* @name detectSeries
* @static
* @memberOf async
* @see `async.detect`
* @see async.detect
* @alias findSeries
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
Expand Down
6 changes: 3 additions & 3 deletions lib/doDuring.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
import during from './during';

/**
* The post-check version of [`during`](#during). To reflect the difference in
* The post-check version of {@link async.during}. To reflect the difference in
* the order of operations, the arguments `test` and `fn` are switched.
*
* Also a version of [`doWhilst`](#doWhilst) with asynchronous `test` function.
* Also a version of {@link async.doWhilst} with asynchronous `test` function.
* @name doDuring
* @static
* @memberOf async
* @see `async.during`
* @see async.during
* @category Control Flow
* @param {Function} fn - A function which is called each time `test` passes.
* The function is passed a `callback(err)`, which must be called once it has
Expand Down
4 changes: 2 additions & 2 deletions lib/doUntil.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,13 @@
import doWhilst from './doWhilst';

/**
* Like [`doWhilst`](#doWhilst), except the `test` is inverted. Note the
* Like {@link async.doWhilst}, except the `test` is inverted. Note the
* argument ordering differs from `until`.
*
* @name doUntil
* @static
* @memberOf async
* @see `async.doWhilst`
* @see async.doWhilst
* @category Control Flow
* @param {Function} fn - A function which is called each time `test` fails.
* The function is passed a `callback(err)`, which must be called once it has
Expand Down
4 changes: 2 additions & 2 deletions lib/doWhilst.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@
import whilst from './whilst';

/**
* The post-check version of [`whilst`](#whilst). To reflect the difference in
* The post-check version of {@link async.whilst}. To reflect the difference in
* the order of operations, the arguments `test` and `fn` are switched.
*
* `doWhilst` is to `whilst` as `do while` is to `while` in plain JavaScript.
*
* @name doWhilst
* @static
* @memberOf async
* @see `async.whilst`
* @see async.whilst
* @category Control Flow
* @param {Function} fn - A function which is called each time `test` passes.
* The function is passed a `callback(err)`, which must be called once it has
Expand Down
4 changes: 2 additions & 2 deletions lib/during.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ import noop from 'lodash/noop';
import rest from 'lodash/rest';

/**
* Like [`whilst`](#whilst), except the `test` is an asynchronous function that
* Like {@link async.whilst}, except the `test` is an asynchronous function that
* is passed a callback in the form of `function (err, truth)`. If error is
* passed to `test` or `fn`, the main callback is immediately called with the
* value of the error.
*
* @name during
* @static
* @memberOf async
* @see `async.whilst`
* @see async.whilst
* @category Control Flow
* @param {Function} test - asynchronous truth test to perform before each
* execution of `fn`. Invoked with (callback).
Expand Down
2 changes: 1 addition & 1 deletion lib/eachLimit.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import withoutIndex from './internal/withoutIndex';
* @name eachLimit
* @static
* @memberOf async
* @see `async.each`
* @see async.each
* @alias forEachLimit
* @category Collection
* @param {Array|Object} coll - A colleciton to iterate over.
Expand Down
2 changes: 1 addition & 1 deletion lib/eachOfLimit.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import _eachOfLimit from './internal/eachOfLimit';
* @name eachOfLimit
* @static
* @memberOf async
* @see `async.eachOf`
* @see async.eachOf
* @alias forEachOfLimit
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
Expand Down
2 changes: 1 addition & 1 deletion lib/eachOfSeries.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import doLimit from './internal/doLimit';
* @name eachOfSeries
* @static
* @memberOf async
* @see `async.eachOf`
* @see async.eachOf
* @alias forEachOfSeries
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
Expand Down
2 changes: 1 addition & 1 deletion lib/eachSeries.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import doLimit from './internal/doLimit';
* @name eachSeries
* @static
* @memberOf async
* @see `async.each`
* @see async.each
* @alias forEachSeries
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
Expand Down
2 changes: 1 addition & 1 deletion lib/everyLimit.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import notId from './internal/notId';
* @name everyLimit
* @static
* @memberOf async
* @see `async.every`
* @see async.every
* @alias allLimit
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
Expand Down
2 changes: 1 addition & 1 deletion lib/everySeries.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import doLimit from './internal/doLimit';
* @name everySeries
* @static
* @memberOf async
* @see `async.every`
* @see async.every
* @alias allSeries
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
Expand Down
2 changes: 1 addition & 1 deletion lib/filterLimit.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import doParallelLimit from './internal/doParallelLimit';
* @name filterLimit
* @static
* @memberOf async
* @see `async.filter`
* @see async.filter
* @alias selectLimit
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
Expand Down
2 changes: 1 addition & 1 deletion lib/filterSeries.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import doLimit from './internal/doLimit';
* @name filterSeries
* @static
* @memberOf async
* @see `async.filter`
* @see async.filter
* @alias selectSeries
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
Expand Down
2 changes: 1 addition & 1 deletion lib/mapLimit.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import map from './internal/map';
* @name mapLimit
* @static
* @memberOf async
* @see `async.map`
* @see async.map
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
* @param {number} limit - The maximum number of async operations at a time.
Expand Down
2 changes: 1 addition & 1 deletion lib/mapSeries.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import doLimit from './internal/doLimit';
* @name mapSeries
* @static
* @memberOf async
* @see `async.map`
* @see async.map
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
* @param {Function} iteratee - A function to apply to each item in `coll`.
Expand Down
2 changes: 1 addition & 1 deletion lib/parallel.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import doLimit from './internal/doLimit';
* It is also possible to use an object instead of an array. Each property will
* be run as a function and the results will be passed to the final `callback`
* as an object instead of an array. This can be a more readable way of handling
* results from [`parallel`](#parallel).
* results from {@link async.parallel}.
*
* @name parallel
* @static
Expand Down
2 changes: 1 addition & 1 deletion lib/parallelLimit.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import parallel from './internal/parallel';
* @name parallel
* @static
* @memberOf async
* @see `async.parallel`
* @see async.parallel
* @category Control Flow
* @param {Array|Collection} tasks - A collection containing functions to run.
* Each function is passed a `callback(err, result)` which it must call on
Expand Down
4 changes: 2 additions & 2 deletions lib/priorityQueue.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ import setImmediate from './setImmediate';
import queue from './queue';

/**
* The same as [`queue`](#queue) only tasks are assigned a priority and
* The same as {@link async.queue} only tasks are assigned a priority and
* completed in ascending priority order.
*
* @name priorityQueue
* @static
* @memberOf async
* @see `async.queue`
* @see async.queue
* @category Control Flow
* @param {Function} worker - An asynchronous function for processing a queued
* task, which must call its `callback(err)` argument when finished, with an
Expand Down
2 changes: 1 addition & 1 deletion lib/reduceRight.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ var slice = Array.prototype.slice;
* @name reduceRight
* @static
* @memberOf async
* @see `async.reduce`
* @see async.reduce
* @alias foldr
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
Expand Down
2 changes: 1 addition & 1 deletion lib/reflectAll.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import reflect from './reflect';
* @name reflectAll
* @static
* @memberOf async
* @see `async.reflect`
* @see async.reflect
* @category Util
* @param {Array} tasks - The array of functions to wrap in `async.reflect`.
* @returns {Array} Returns an array of functions, each function wrapped in
Expand Down
2 changes: 1 addition & 1 deletion lib/reject.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import doLimit from './internal/doLimit';
* @name reject
* @static
* @memberOf async
* @see `async.filter`
* @see async.filter
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
* @param {Function} iteratee - A truth test to apply to each item in `coll`.
Expand Down
2 changes: 1 addition & 1 deletion lib/rejectLimit.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import doParallelLimit from './internal/doParallelLimit';
* @name rejectLimit
* @static
* @memberOf async
* @see `async.reject`
* @see async.reject
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
* @param {number} limit - The maximum number of async operations at a time.
Expand Down
2 changes: 1 addition & 1 deletion lib/rejectSeries.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import doLimit from './internal/doLimit';
* @name rejectSeries
* @static
* @memberOf async
* @see `async.reject`
* @see async.reject
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
* @param {Function} iteratee - A truth test to apply to each item in `coll`.
Expand Down
2 changes: 1 addition & 1 deletion lib/retryable.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import initialParams from './internal/initialParams';
* @name retryable
* @static
* @memberOf async
* @see `async.retry`
* @see async.retry
* @category Control Flow
* @param {Object|number} [opts = {times: 5, interval: 0}| 5] - optional
* options, exactly the same as from `retry`
Expand Down
4 changes: 2 additions & 2 deletions lib/seq.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,14 @@ import reduce from './reduce';
/**
* Version of the compose function that is more natural to read. Each function
* consumes the return value of the previous function. It is the equivalent of
* [`compose`](#compose) with the arguments reversed.
* {@link async.compose} with the arguments reversed.
*
* Each function is executed with the `this` binding of the composed function.
*
* @name seq
* @static
* @memberOf async
* @see `async.compose`
* @see async.compose
* @category Control Flow
* @param {...Function} functions - the asynchronous functions to compose
* @example
Expand Down
2 changes: 1 addition & 1 deletion lib/series.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import eachOfSeries from './eachOfSeries';
* It is also possible to use an object instead of an array. Each property will
* be run as a function, and the results will be passed to the final `callback`
* as an object instead of an array. This can be a more readable way of handling
* results from [`series`](#series).
* results from {@link async.series}.
*
* **Note** that while many implementations preserve the order of object
* properties, the [ECMAScript Language Specification](http://www.ecma-international.org/ecma-262/5.1/#sec-8.6)
Expand Down
2 changes: 1 addition & 1 deletion lib/someLimit.js
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import identity from 'lodash/identity';
* @name someLimit
* @static
* @memberOf async
* @see `async.some`
* @see async.some
* @alias anyLimit
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
Expand Down
2 changes: 1 addition & 1 deletion lib/someSeries.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import doLimit from './internal/doLimit';
* @name someSeries
* @static
* @memberOf async
* @see `async.some`
* @see async.some
* @alias anySeries
* @category Collection
* @param {Array|Object} coll - A collection to iterate over.
Expand Down
6 changes: 3 additions & 3 deletions lib/times.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ import doLimit from './internal/doLimit';

/**
* Calls the `iteratee` function `n` times, and accumulates results in the same
* manner you would use with [`map`](#map).
* manner you would use with {@link async.map}.
*
* @name times
* @static
* @memberOf async
* @see `async.map`
* @see async.map
* @category Control Flow
* @param {number} n - The number of times to run the function.
* @param {Function} iteratee - The function to call `n` times. Invoked with the
* iteration index and a callback (n, next).
* @param {Function} callback - see [`map`](#map).
* @param {Function} callback - see {@link async.map}.
* @example
*
* // Pretend this is some complicated async factory
Expand Down
Loading