docs(resource): clarify success callback arguments

Narretz · Narretz · commit 720012eab6fe · 2015-06-16T19:50:42.000+02:00
Closes angular#7730
diff --git a/src/ngResource/resource.js b/src/ngResource/resource.js
@@ -209,7 +209,8 @@ function shallowClearAndCopy(src, dst) {
  *   - non-GET instance actions:  `instance.$action([parameters], [success], [error])`
  *
  *
- *   Success callback is called with (value, responseHeaders) arguments. Error callback is called
+ *   Success callback is called with (value, responseHeaders) arguments, where the value is
+ *   the populated resource instance or collection object. The error callback is called
  *   with (httpResponse) argument.
  *
  *   Class actions return empty instance (with additional properties below).

Original file line number	Diff line number	Diff line change
`@@ -209,7 +209,8 @@ function shallowClearAndCopy(src, dst) {`
`209`	`209`	* - non-GET instance actions: `instance.$action([parameters], [success], [error])`
`210`	`210`	`*`
`211`	`211`	`*`
`212`		`- * Success callback is called with (value, responseHeaders) arguments. Error callback is called`
	`212`	`+ * Success callback is called with (value, responseHeaders) arguments, where the value is`
	`213`	`+ * the populated resource instance or collection object. The error callback is called`
`213`	`214`	`* with (httpResponse) argument.`
`214`	`215`	`*`
`215`	`216`	`* Class actions return empty instance (with additional properties below).`