docs($animate): fix misleading $animate.cancel example

olexme · petebacondarwin · commit 7d70dcdab164 · 2014-12-17T20:14:22.000Z
The given example is wrong, you can't cancel the promise returned by "then" since it is not the one originally tracked by "addClass". Closes #10498
diff --git a/src/ngAnimate/animate.js b/src/ngAnimate/animate.js
@@ -833,7 +833,8 @@ angular.module('ngAnimate', ['ng'])
        * promise that was returned when the animation was started.
        *
        * ```js
-       * var promise = $animate.addClass(element, 'super-long-animation').then(function() {
+       * var promise = $animate.addClass(element, 'super-long-animation');
+       * promise.then(function() {
        *   //this will still be called even if cancelled
        * });
        *

Original file line number	Diff line number	Diff line change
`@@ -833,7 +833,8 @@ angular.module('ngAnimate', ['ng'])`
`833`	`833`	`* promise that was returned when the animation was started.`
`834`	`834`	`*`
`835`	`835`	* ```js
`836`		`- * var promise = $animate.addClass(element, 'super-long-animation').then(function() {`
	`836`	`+ * var promise = $animate.addClass(element, 'super-long-animation');`
	`837`	`+ * promise.then(function() {`
`837`	`838`	`* //this will still be called even if cancelled`
`838`	`839`	`* });`
`839`	`840`	`*`