docs($q): explain what the $q service does in description

btelles · caitp · commit 22ecbc50f49e · 2014-11-14T11:09:37.000-05:00
Explain what the $q service does in description, instead of origin document. The original explanation was less accessible to people new to promises and JS in general. Closes angular#10056
diff --git a/src/ng/q.js b/src/ng/q.js
@@ -6,7 +6,11 @@
  * @requires $rootScope
  *
  * @description
- * A promise/deferred implementation inspired by [Kris Kowal's Q](https://github.com/kriskowal/q).
+ * A service that helps you run functions asynchronously, and use their return values (or exceptions) 
+ * when they are done processing. 
+ * 
+ * This is an implementation of promises/deferred objects inspired by 
+ * [Kris Kowal's Q](https://github.com/kriskowal/q).
  *
  * $q can be used in two fashions --- one which is more similar to Kris Kowal's Q or jQuery's Deferred
  * implementations, and the other which resembles ES6 promises to some degree.

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,11 @@`
`6`	`6`	`* @requires $rootScope`
`7`	`7`	`*`
`8`	`8`	`* @description`
`9`		`- * A promise/deferred implementation inspired by [Kris Kowal's Q](https://github.com/kriskowal/q).`
	`9`	`+ * A service that helps you run functions asynchronously, and use their return values (or exceptions)`
	`10`	`+ * when they are done processing.`
	`11`	`+ *`
	`12`	`+ * This is an implementation of promises/deferred objects inspired by`
	`13`	`+ * [Kris Kowal's Q](https://github.com/kriskowal/q).`
`10`	`14`	`*`
`11`	`15`	`* $q can be used in two fashions --- one which is more similar to Kris Kowal's Q or jQuery's Deferred`
`12`	`16`	`* implementations, and the other which resembles ES6 promises to some degree.`