aboutsummaryrefslogtreecommitdiffstats
path: root/src/apis.js
diff options
context:
space:
mode:
authorMisko Hevery2011-03-05 22:52:37 -0800
committerMisko Hevery2011-03-05 22:54:41 -0800
commit4c762bfe5c6421560af9d4388ddc6506421b9c45 (patch)
tree28c2e2c092e2ec496c6b5e0ca8bbdef814ebcb3e /src/apis.js
parent749b3e87637227f65c17080ea447a0c5eec4fd7e (diff)
downloadangular.js-4c762bfe5c6421560af9d4388ddc6506421b9c45.tar.bz2
fix orberBy documentation error
Diffstat (limited to 'src/apis.js')
-rw-r--r--src/apis.js5
1 files changed, 3 insertions, 2 deletions
diff --git a/src/apis.js b/src/apis.js
index 9fc45619..1ca33208 100644
--- a/src/apis.js
+++ b/src/apis.js
@@ -541,12 +541,13 @@ var angularArray = {
* {@link angular.Array} for more info.
*
* @param {Array} array The array to sort.
- * @param {function(*, *)|string|Array.<(function(*, *)|string)>} expression A predicate to be
+ * @param {function(*)|string|Array.<(function(*)|string)>} expression A predicate to be
* used by the comparator to determine the order of elements.
*
* Can be one of:
*
- * - `function`: JavaScript's Array#sort comparator function
+ * - `function`: getter function. The result of this function will be sorted using the
+ * `<`, `=`, `>` operator
* - `string`: angular expression which evaluates to an object to order by, such as 'name' to
* sort by a property called 'name'. Optionally prefixed with `+` or `-` to control ascending
* or descending sort order (e.g. +name or -name).