From cb94b03e3efdf33d9295de87520755f04234a416 Mon Sep 17 00:00:00 2001 From: jdalton Date: Sat, 4 Jul 2015 14:56:49 -0700 Subject: [PATCH] Document more default params. [ci skip] --- lodash.src.js | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/lodash.src.js b/lodash.src.js index 057792706..aef4caa9d 100644 --- a/lodash.src.js +++ b/lodash.src.js @@ -456,7 +456,7 @@ * @private * @param {Object} object The object to compare. * @param {Object} other The other object to compare. - * @param {boolean[]} orders The order to sort by for each property. + * @param {boolean[]|string[]} orders The order to sort by for each property. * @returns {number} Returns the sort order indicator for `object`. */ function compareMultiple(object, other, orders) { @@ -5580,7 +5580,7 @@ * @category Array * @param {Array} array The array to inspect. * @param {boolean} [isSorted] Specify the array is sorted. - * @param {Function|Object|string} [iteratee] The function invoked per iteration. + * @param {Function|Object|string} [iteratee=_.identity] The function invoked per iteration. * @returns {Array} Returns the new duplicate-value-free array. * @example * @@ -5808,7 +5808,7 @@ * @memberOf _ * @category Array * @param {...Array} [arrays] The arrays to process. - * @param {Function} [iteratee] The function to combine grouped values. + * @param {Function} [iteratee=_.identity] The function to combine grouped values. * @returns {Array} Returns the new array of grouped elements. * @example * @@ -6883,8 +6883,8 @@ * @memberOf _ * @category Collection * @param {Array|Object|string} collection The collection to iterate over. - * @param {Function[]|Object[]|string[]} iteratees The iteratees to sort by. - * @param {boolean[]} [orders] The sort orders of `iteratees`. + * @param {Function[]|Object[]|string[]} [iteratees=[_.identity]] The iteratees to sort by. + * @param {boolean[]|string[]} [orders] The sort orders of `iteratees`. * @param- {Object} [guard] Enables use as an iteratee for functions like `_.reduce`. * @returns {Array} Returns the new sorted array. * @example @@ -11300,7 +11300,7 @@ * @memberOf _ * @category Math * @param {Array|Object|string} collection The collection to iterate over. - * @param {Function|Object|string} [iteratee] The function invoked per iteration. + * @param {Function|Object|string} [iteratee=_.identity] The function invoked per iteration. * @returns {*} Returns the maximum value. * @example * @@ -11334,7 +11334,7 @@ * @memberOf _ * @category Math * @param {Array|Object|string} collection The collection to iterate over. - * @param {Function|Object|string} [iteratee] The function invoked per iteration. + * @param {Function|Object|string} [iteratee=_.identity] The function invoked per iteration. * @returns {*} Returns the minimum value. * @example * @@ -11387,7 +11387,7 @@ * @memberOf _ * @category Math * @param {Array|Object|string} collection The collection to iterate over. - * @param {Function|Object|string} [iteratee] The function invoked per iteration. + * @param {Function|Object|string} [iteratee=_.identity] The function invoked per iteration. * @param- {Object} [guard] Enables use as an iteratee for functions like `_.map`. * @returns {number} Returns the sum. * @example