docs(filterFilter): clarify the comparator parameter

Rodrigo · gkalpak · commit b9d2b30808db · 2017-03-23T16:00:37.000+02:00
Closes #15827
diff --git a/src/ng/filter/filter.js b/src/ng/filter/filter.js
@@ -45,8 +45,9 @@
  *     The final result is an array of those elements that the predicate returned true for.
  *
  * @param {function(actual, expected)|true|false} [comparator] Comparator which is used in
- *     determining if the expected value (from the filter expression) and actual value (from
- *     the object in the array) should be considered a match.
+ *     determining if values retrieved using `expression` (when it is not a function) should be
+ *     considered a match based on the the expected value (from the filter expression) and actual
+ *     value (from the object in the array).
  *
  *   Can be one of:
  *

Original file line number	Diff line number	Diff line change
`@@ -45,8 +45,9 @@`
`45`	`45`	`* The final result is an array of those elements that the predicate returned true for.`
`46`	`46`	`*`
`47`	`47`	`* @param {function(actual, expected)\|true\|false} [comparator] Comparator which is used in`
`48`		`- * determining if the expected value (from the filter expression) and actual value (from`
`49`		`- * the object in the array) should be considered a match.`
	`48`	+ * determining if values retrieved using `expression` (when it is not a function) should be
	`49`	`+ * considered a match based on the the expected value (from the filter expression) and actual`
	`50`	`+ * value (from the object in the array).`
`50`	`51`	`*`
`51`	`52`	`* Can be one of:`
`52`	`53`	`*`