From 25a8d97750b2847baad8a5a0052f6ee1a33b0ddc Mon Sep 17 00:00:00 2001 From: Kyle Wuolle Date: Sun, 6 Nov 2016 10:28:13 -0800 Subject: [PATCH] fix($filter): change documentation of $filter to reflect optional comparator parameter change the documentation for $filter so that the comparator parameter is marked optional. Also specified that the default value is false. Closes #15312 --- src/ng/filter/filter.js | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/ng/filter/filter.js b/src/ng/filter/filter.js index fe163d33e64f..20edabf10225 100644 --- a/src/ng/filter/filter.js +++ b/src/ng/filter/filter.js @@ -41,9 +41,9 @@ * * The final result is an array of those elements that the predicate returned true for. * - * @param {function(actual, expected)|true|undefined} comparator Comparator which is used in + * @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. + * the object in the array) should be considered a match. * * Can be one of: * @@ -54,13 +54,13 @@ * - `true`: A shorthand for `function(actual, expected) { return angular.equals(actual, expected)}`. * This is essentially strict comparison of expected and actual. * - * - `false|undefined`: A short hand for a function which will look for a substring match in case + * - `false`: A short hand for a function which will look for a substring match in case * insensitive way. * * Primitive values are converted to strings. Objects are not compared against primitives, - * unless they have a custom `toString` method (e.g. `Date` objects). + * unless they have a custom `toString` method (e.g. `Date` objects). By default `false`. * - * @param {string=} anyPropertyKey The special property name that matches against any property. + * @param {string=} [anyPropertyKey] The special property name that matches against any property. * By default `$`. * * @example