docs(filterFilter): clarify the comparator parameter

Closes #15827
2017-03-17 08:46:18 -03:00
parent 3d0abffbc0
commit b9d2b30808
1 changed files with 3 additions and 2 deletions
@@ -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:
 *