docs($q): fix typos

This commit is contained in:
radu
2013-02-06 17:16:56 -05:00
committed by Igor Minar
parent 9a3a9b46e5
commit a8e114f351

View File

@@ -12,7 +12,7 @@
* interface for interacting with an object that represents the result of an action that is * interface for interacting with an object that represents the result of an action that is
* performed asynchronously, and may or may not be finished at any given point in time. * performed asynchronously, and may or may not be finished at any given point in time.
* *
* From the perspective of dealing with error handling, deferred and promise apis are to * From the perspective of dealing with error handling, deferred and promise APIs are to
* asynchronous programming what `try`, `catch` and `throw` keywords are to synchronous programming. * asynchronous programming what `try`, `catch` and `throw` keywords are to synchronous programming.
* *
* <pre> * <pre>
@@ -47,7 +47,7 @@
* *
* At first it might not be obvious why this extra complexity is worth the trouble. The payoff * At first it might not be obvious why this extra complexity is worth the trouble. The payoff
* comes in the way of * comes in the way of
* [guarantees that promise and deferred apis make](https://github.com/kriskowal/uncommonjs/blob/master/promises/specification.md). * [guarantees that promise and deferred APIs make](https://github.com/kriskowal/uncommonjs/blob/master/promises/specification.md).
* *
* Additionally the promise api allows for composition that is very hard to do with the * Additionally the promise api allows for composition that is very hard to do with the
* traditional callback ([CPS](http://en.wikipedia.org/wiki/Continuation-passing_style)) approach. * traditional callback ([CPS](http://en.wikipedia.org/wiki/Continuation-passing_style)) approach.
@@ -59,7 +59,7 @@
* *
* A new instance of deferred is constructed by calling `$q.defer()`. * A new instance of deferred is constructed by calling `$q.defer()`.
* *
* The purpose of the deferred object is to expose the associated Promise instance as well as apis * The purpose of the deferred object is to expose the associated Promise instance as well as APIs
* that can be used for signaling the successful or unsuccessful completion of the task. * that can be used for signaling the successful or unsuccessful completion of the task.
* *
* **Methods** * **Methods**
@@ -136,7 +136,7 @@
* expect(resolvedValue).toBeUndefined(); * expect(resolvedValue).toBeUndefined();
* *
* // Simulate resolving of promise * // Simulate resolving of promise
* defered.resolve(123); * deferred.resolve(123);
* // Note that the 'then' function does not get called synchronously. * // Note that the 'then' function does not get called synchronously.
* // This is because we want the promise API to always be async, whether or not * // This is because we want the promise API to always be async, whether or not
* // it got called synchronously or asynchronously. * // it got called synchronously or asynchronously.
@@ -317,7 +317,7 @@ function qFactory(nextTick, exceptionHandler) {
* *
* @param {*} value Value or a promise * @param {*} value Value or a promise
* @returns {Promise} Returns a single promise that will be resolved with an array of values, * @returns {Promise} Returns a single promise that will be resolved with an array of values,
* each value coresponding to the promise at the same index in the `promises` array. If any of * each value corresponding to the promise at the same index in the `promises` array. If any of
* the promises is resolved with a rejection, this resulting promise will be resolved with the * the promises is resolved with a rejection, this resulting promise will be resolved with the
* same rejection. * same rejection.
*/ */
@@ -379,7 +379,7 @@ function qFactory(nextTick, exceptionHandler) {
* *
* @param {Array.<Promise>} promises An array of promises. * @param {Array.<Promise>} promises An array of promises.
* @returns {Promise} Returns a single promise that will be resolved with an array of values, * @returns {Promise} Returns a single promise that will be resolved with an array of values,
* each value coresponding to the promise at the same index in the `promises` array. If any of * each value corresponding to the promise at the same index in the `promises` array. If any of
* the promises is resolved with a rejection, this resulting promise will be resolved with the * the promises is resolved with a rejection, this resulting promise will be resolved with the
* same rejection. * same rejection.
*/ */