Add more doc notes on the order of results. [ci skip] [closes #2622]

This commit is contained in:
John-David Dalton
2016-09-01 11:41:38 -07:00
parent d47123779e
commit 212e4a6407

View File

@@ -6704,8 +6704,8 @@
/** /**
* Creates an array of `array` values not included in the other given arrays * Creates an array of `array` values not included in the other given arrays
* using [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) * using [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero)
* for equality comparisons. The order of result values is determined by the * for equality comparisons. The order and references of result values are
* order they occur in the first array. * determined by the first array.
* *
* **Note:** Unlike `_.pullAll`, this method returns a new array. * **Note:** Unlike `_.pullAll`, this method returns a new array.
* *
@@ -6731,8 +6731,9 @@
/** /**
* This method is like `_.difference` except that it accepts `iteratee` which * This method is like `_.difference` except that it accepts `iteratee` which
* is invoked for each element of `array` and `values` to generate the criterion * is invoked for each element of `array` and `values` to generate the criterion
* by which they're compared. Result values are chosen from the first array. * by which they're compared. The order and references of result values are
* The iteratee is invoked with one argument: (value). * determined by the first array. The iteratee is invoked with one argument:
* (value).
* *
* **Note:** Unlike `_.pullAllBy`, this method returns a new array. * **Note:** Unlike `_.pullAllBy`, this method returns a new array.
* *
@@ -6765,9 +6766,9 @@
/** /**
* This method is like `_.difference` except that it accepts `comparator` * This method is like `_.difference` except that it accepts `comparator`
* which is invoked to compare elements of `array` to `values`. Result values * which is invoked to compare elements of `array` to `values`. The order and
* are chosen from the first array. The comparator is invoked with two arguments: * references of result values are determined by the first array. The comparator
* (arrVal, othVal). * is invoked with two arguments: (arrVal, othVal).
* *
* **Note:** Unlike `_.pullAllWith`, this method returns a new array. * **Note:** Unlike `_.pullAllWith`, this method returns a new array.
* *
@@ -7261,8 +7262,8 @@
/** /**
* Creates an array of unique values that are included in all given arrays * Creates an array of unique values that are included in all given arrays
* using [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) * using [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero)
* for equality comparisons. The order of result values is determined by the * for equality comparisons. The order and references of result values are
* order they occur in the first array. * determined by the first array.
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -7285,8 +7286,9 @@
/** /**
* This method is like `_.intersection` except that it accepts `iteratee` * This method is like `_.intersection` except that it accepts `iteratee`
* which is invoked for each element of each `arrays` to generate the criterion * which is invoked for each element of each `arrays` to generate the criterion
* by which they're compared. Result values are chosen from the first array. * by which they're compared. The order and references of result values are
* The iteratee is invoked with one argument: (value). * determined by the first array. The iteratee is invoked with one argument:
* (value).
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -7320,9 +7322,9 @@
/** /**
* This method is like `_.intersection` except that it accepts `comparator` * This method is like `_.intersection` except that it accepts `comparator`
* which is invoked to compare elements of `arrays`. Result values are chosen * which is invoked to compare elements of `arrays`. The order and references
* from the first array. The comparator is invoked with two arguments: * of result values are determined by the first array. The comparator is
* (arrVal, othVal). * invoked with two arguments: (arrVal, othVal).
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -8161,8 +8163,9 @@
/** /**
* Creates a duplicate-free version of an array, using * Creates a duplicate-free version of an array, using
* [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) * [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero)
* for equality comparisons, in which only the first occurrence of each * for equality comparisons, in which only the first occurrence of each element
* element is kept. * is kept. The order of result values is determined by the order they occur
* in the array.
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -8184,7 +8187,9 @@
/** /**
* This method is like `_.uniq` except that it accepts `iteratee` which is * This method is like `_.uniq` except that it accepts `iteratee` which is
* invoked for each element in `array` to generate the criterion by which * invoked for each element in `array` to generate the criterion by which
* uniqueness is computed. The iteratee is invoked with one argument: (value). * uniqueness is computed. The order of result values is determined by the
* order they occur in the array. The iteratee is invoked with one argument:
* (value).
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -8211,8 +8216,9 @@
/** /**
* This method is like `_.uniq` except that it accepts `comparator` which * This method is like `_.uniq` except that it accepts `comparator` which
* is invoked to compare elements of `array`. The comparator is invoked with * is invoked to compare elements of `array`. The order of result values is
* two arguments: (arrVal, othVal). * determined by the order they occur in the array.The comparator is invoked
* with two arguments: (arrVal, othVal).
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -8354,8 +8360,9 @@
/** /**
* This method is like `_.xor` except that it accepts `iteratee` which is * This method is like `_.xor` except that it accepts `iteratee` which is
* invoked for each element of each `arrays` to generate the criterion by * invoked for each element of each `arrays` to generate the criterion by
* which by which they're compared. The iteratee is invoked with one argument: * which by which they're compared. The order of result values is determined
* (value). * by the order they occur in the arrays. The iteratee is invoked with one
* argument: (value).
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -8384,8 +8391,9 @@
/** /**
* This method is like `_.xor` except that it accepts `comparator` which is * This method is like `_.xor` except that it accepts `comparator` which is
* invoked to compare elements of `arrays`. The comparator is invoked with * invoked to compare elements of `arrays`. The order of result values is
* two arguments: (arrVal, othVal). * determined by the order they occur in the arrays. The comparator is invoked
* with two arguments: (arrVal, othVal).
* *
* @static * @static
* @memberOf _ * @memberOf _