docs(orderBy): clarify how sorting is processed

Ryan Hall · petebacondarwin · commit 0d691a6febaa · 2014-04-28T14:53:34.000+01:00
An API was passing me numbers as strings (ex. '8.25'), and I was noticing weird sorting behavior with `orderBy` because it was trying to sort the numbers alphabetically. Closes #5436
diff --git a/src/ng/filter/orderBy.js b/src/ng/filter/orderBy.js
@@ -6,7 +6,9 @@
  * @function
  *
  * @description
- * Orders a specified `array` by the `expression` predicate.
+ * Orders a specified `array` by the `expression` predicate. It is ordered alphabetically
+ * for strings and numerically for numbers. Note: if you notice numbers are not being sorted
+ * correctly, make sure they are actually being saved as numbers and not strings.
  *
  * @param {Array} array The array to sort.
  * @param {function(*)|string|Array.<(function(*)|string)>} expression A predicate to be

Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,9 @@`
`6`	`6`	`* @function`
`7`	`7`	`*`
`8`	`8`	`* @description`
`9`		- * Orders a specified `array` by the `expression` predicate.
	`9`	+ * Orders a specified `array` by the `expression` predicate. It is ordered alphabetically
	`10`	`+ * for strings and numerically for numbers. Note: if you notice numbers are not being sorted`
	`11`	`+ * correctly, make sure they are actually being saved as numbers and not strings.`
`10`	`12`	`*`
`11`	`13`	`* @param {Array} array The array to sort.`
`12`	`14`	`* @param {function()\|string\|Array.<(function()\|string)>} expression A predicate to be`