docs($interval): Update interval promise docs

trezm · gkalpak · commit f3aa1d183a73 · 2017-03-25T18:08:38.000+02:00
It's currently not clear when or why the promise returned by `$interval` resolves. This updates the docs to be more specific. Closes angular#15862
diff --git a/src/ng/interval.js b/src/ng/interval.js
@@ -41,7 +41,7 @@ function $IntervalProvider() {
       * @param {boolean=} [invokeApply=true] If set to `false` skips model dirty checking, otherwise
       *   will invoke `fn` within the {@link ng.$rootScope.Scope#$apply $apply} block.
       * @param {...*=} Pass additional parameters to the executed function.
-      * @returns {promise} A promise which will be notified on each iteration.
+      * @returns {promise} A promise which will be notified on each iteration. It will resolve once all iterations of the interval complete.
       *
       * @example
       * <example module="intervalExample" name="interval-service">

Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ function $IntervalProvider() {`
`41`	`41`	* @param {boolean=} [invokeApply=true] If set to `false` skips model dirty checking, otherwise
`42`	`42`	* will invoke `fn` within the {@link ng.$rootScope.Scope#$apply $apply} block.
`43`	`43`	`* @param {...*=} Pass additional parameters to the executed function.`
`44`		`- * @returns {promise} A promise which will be notified on each iteration.`
	`44`	`+ * @returns {promise} A promise which will be notified on each iteration. It will resolve once all iterations of the interval complete.`
`45`	`45`	`*`
`46`	`46`	`* @example`
`47`	`47`	`* <example module="intervalExample" name="interval-service">`