Mirrors/lodash
1
0
Fork 0
mirror of https://github.com/whoisclebs/lodash.git synced 2026-02-08 02:17:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

More doc tweaks. [ci skip]

Browse Source
This commit is contained in:
John-David Dalton
2014-04-06 11:30:47 -07:00
parent 0341399e54
commit a14e2fedcf
4 changed files with 55 additions and 54 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
dist/lodash.compat.js vendored
View File

@@ -253,7 +253,7 @@
* @private * @private
* @param {*} value The value to compare to `other`. * @param {*} value The value to compare to `other`.
* @param {*} other The value to compare to `value`. * @param {*} other The value to compare to `value`.
* @returns {number} Returns the sort order indicator for `a`. * @returns {number} Returns the sort order indicator for `value`.
*/ */
function baseCompareAscending(value, other) { function baseCompareAscending(value, other) {
if (value !== other) { if (value !== other) {
@@ -306,11 +306,11 @@
* collection is a string value. * collection is a string value.
* *
* @private * @private
* @param {string} value The character to inspect. * @param {string} string The string to inspect.
* @returns {number} Returns the code unit of the given character. * @returns {number} Returns the code unit of the first character of the string.
*/ */
function charAtCallback(value) { function charAtCallback(string) {
return value.charCodeAt(0); return string.charCodeAt(0);
} }
/** /**
@@ -318,7 +318,7 @@
* *
* @private * @private
* @param {string} string The string to inspect. * @param {string} string The string to inspect.
* @param {string} chars The chars to find. * @param {string} chars The characters to find.
* @returns {number} Returns the index of the first character not found in `chars`. * @returns {number} Returns the index of the first character not found in `chars`.
*/ */
function charsLeftIndex(string, chars) { function charsLeftIndex(string, chars) {
@@ -338,7 +338,7 @@
* *
* @private * @private
* @param {string} string The string to inspect. * @param {string} string The string to inspect.
* @param {string} chars The chars to find. * @param {string} chars The characters to find.
* @returns {number} Returns the index of the last character not found in `chars`. * @returns {number} Returns the index of the last character not found in `chars`.
*/ */
function charsRightIndex(string, chars) { function charsRightIndex(string, chars) {
@@ -356,7 +356,7 @@
* sort them in ascending order. * sort them in ascending order.
* *
* @private * @private
* @param {Object} value The object to compare to `other`. * @param {Object} object The object to compare to `other`.
* @param {Object} other The object to compare to `object`. * @param {Object} other The object to compare to `object`.
* @returns {number} Returns the sort order indicator for `object`. * @returns {number} Returns the sort order indicator for `object`.
*/ */
@@ -369,7 +369,7 @@
* collection and stable sort them in ascending order. * collection and stable sort them in ascending order.
* *
* @private * @private
* @param {Object} value The object to compare to `other`. * @param {Object} object The object to compare to `other`.
* @param {Object} other The object to compare to `object`. * @param {Object} other The object to compare to `object`.
* @returns {number} Returns the sort order indicator for `object`. * @returns {number} Returns the sort order indicator for `object`.
*/ */
@@ -386,7 +386,7 @@
} }
} }
// Fixes an `Array#sort` bug in the JS engine embedded in Adobe applications // Fixes an `Array#sort` bug in the JS engine embedded in Adobe applications
// that causes it, under certain circumstances, to provided the same value // that causes it, under certain circumstances, to provide the same value
// for `object` and `other`. See https://github.com/jashkenas/underscore/pull/1247 // for `object` and `other`. See https://github.com/jashkenas/underscore/pull/1247
// //
// This also ensures a stable sort in V8 and other engines. // This also ensures a stable sort in V8 and other engines.
@@ -689,7 +689,7 @@
ctorByClass[regexpClass] = RegExp; ctorByClass[regexpClass] = RegExp;
ctorByClass[stringClass] = String; ctorByClass[stringClass] = String;
/** Used to avoid iterating non-enumerable properties in IE < 9 */ /** Used to avoid iterating over non-enumerable properties in IE < 9 */
var nonEnumProps = {}; var nonEnumProps = {};
nonEnumProps[arrayClass] = nonEnumProps[dateClass] = nonEnumProps[numberClass] = { 'constructor': true, 'toLocaleString': true, 'toString': true, 'valueOf': true }; nonEnumProps[arrayClass] = nonEnumProps[dateClass] = nonEnumProps[numberClass] = { 'constructor': true, 'toLocaleString': true, 'toString': true, 'valueOf': true };
nonEnumProps[boolClass] = nonEnumProps[stringClass] = { 'constructor': true, 'toString': true, 'valueOf': true }; nonEnumProps[boolClass] = nonEnumProps[stringClass] = { 'constructor': true, 'toString': true, 'valueOf': true };
@@ -1427,7 +1427,7 @@
} }
/** /**
* The base implementation of `_.find`, '_.findLast`, `_.findKey`, and `_.findLastKey` * The base implementation of `_.find`, `_.findLast`, `_.findKey`, and `_.findLastKey`
* without support for callback shorthands or `this` binding which iterates * without support for callback shorthands or `this` binding which iterates
* over `collection` using the provided `eachFunc`. * over `collection` using the provided `eachFunc`.
* *
@@ -1922,7 +1922,7 @@
* placeholders, and provided arguments into a single array of arguments. * placeholders, and provided arguments into a single array of arguments.
* *
* @private * @private
* @param {Array} partialArg An array of arguments to prepend to those provided. * @param {Array} partialArgs An array of arguments to prepend to those provided.
* @param {Array} partialHolders An array of `partialArgs` placeholder indexes. * @param {Array} partialHolders An array of `partialArgs` placeholder indexes.
* @param {Array|Object} args The provided arguments. * @param {Array|Object} args The provided arguments.
* @returns {Array} Returns the new array of composed arguments. * @returns {Array} Returns the new array of composed arguments.
@@ -1952,7 +1952,7 @@
* is tailored for `_.partialRight`. * is tailored for `_.partialRight`.
* *
* @private * @private
* @param {Array} partialRightArg An array of arguments to append to those provided. * @param {Array} partialRightArgs An array of arguments to append to those provided.
* @param {Array} partialHolders An array of `partialRightArgs` placeholder indexes. * @param {Array} partialHolders An array of `partialRightArgs` placeholder indexes.
* @param {Array|Object} args The provided arguments. * @param {Array|Object} args The provided arguments.
* @returns {Array} Returns the new array of composed arguments. * @returns {Array} Returns the new array of composed arguments.
@@ -2742,7 +2742,7 @@
* @static * @static
* @memberOf _ * @memberOf _
* @category Arrays * @category Arrays
* @param {...Array} [array] The arrays to inspect. * @param {...Array} [arrays] The arrays to inspect.
* @returns {Array} Returns the new array of shared values. * @returns {Array} Returns the new array of shared values.
* @example * @example
* *
@@ -2871,7 +2871,7 @@
* @memberOf _ * @memberOf _
* @category Arrays * @category Arrays
* @param {Array} array The array to modify. * @param {Array} array The array to modify.
* @param {...*} [value] The values to remove. * @param {...*} [values] The values to remove.
* @returns {Array} Returns `array`. * @returns {Array} Returns `array`.
* @example * @example
* *
@@ -3234,7 +3234,7 @@
* @static * @static
* @memberOf _ * @memberOf _
* @category Arrays * @category Arrays
* @param {...Array} [array] The arrays to inspect. * @param {...Array} [arrays] The arrays to inspect.
* @returns {Array} Returns the new array of combined values. * @returns {Array} Returns the new array of combined values.
* @example * @example
* *
@@ -3323,7 +3323,7 @@
* @memberOf _ * @memberOf _
* @category Arrays * @category Arrays
* @param {Array} array The array to filter. * @param {Array} array The array to filter.
* @param {...*} [value] The values to exclude. * @param {...*} [values] The values to exclude.
* @returns {Array} Returns the new array of filtered values. * @returns {Array} Returns the new array of filtered values.
* @example * @example
* *
@@ -3342,7 +3342,7 @@
* @static * @static
* @memberOf _ * @memberOf _
* @category Arrays * @category Arrays
* @param {...Array} [array] The arrays to inspect. * @param {...Array} [arrays] The arrays to inspect.
* @returns {Array} Returns the new array of values. * @returns {Array} Returns the new array of values.
* @example * @example
* *
@@ -3377,7 +3377,7 @@
* @memberOf _ * @memberOf _
* @alias unzip * @alias unzip
* @category Arrays * @category Arrays
* @param {...Array} [array] The arrays to process. * @param {...Array} [arrays] The arrays to process.
* @returns {Array} Returns the array of grouped elements. * @returns {Array} Returns the array of grouped elements.
* @example * @example
* *
@@ -7862,7 +7862,7 @@
} }
/** /**
* Reverts the '_' variable to its previous value and returns a reference to * Reverts the `_` variable to its previous value and returns a reference to
* the `lodash` function. * the `lodash` function.
* *
* @static * @static

40
dist/lodash.js vendored
View File

@@ -246,7 +246,7 @@
* @private * @private
* @param {*} value The value to compare to `other`. * @param {*} value The value to compare to `other`.
* @param {*} other The value to compare to `value`. * @param {*} other The value to compare to `value`.
* @returns {number} Returns the sort order indicator for `a`. * @returns {number} Returns the sort order indicator for `value`.
*/ */
function baseCompareAscending(value, other) { function baseCompareAscending(value, other) {
if (value !== other) { if (value !== other) {
@@ -299,11 +299,11 @@
* collection is a string value. * collection is a string value.
* *
* @private * @private
* @param {string} value The character to inspect. * @param {string} string The string to inspect.
* @returns {number} Returns the code unit of the given character. * @returns {number} Returns the code unit of the first character of the string.
*/ */
function charAtCallback(value) { function charAtCallback(string) {
return value.charCodeAt(0); return string.charCodeAt(0);
} }
/** /**
@@ -311,7 +311,7 @@
* *
* @private * @private
* @param {string} string The string to inspect. * @param {string} string The string to inspect.
* @param {string} chars The chars to find. * @param {string} chars The characters to find.
* @returns {number} Returns the index of the first character not found in `chars`. * @returns {number} Returns the index of the first character not found in `chars`.
*/ */
function charsLeftIndex(string, chars) { function charsLeftIndex(string, chars) {
@@ -331,7 +331,7 @@
* *
* @private * @private
* @param {string} string The string to inspect. * @param {string} string The string to inspect.
* @param {string} chars The chars to find. * @param {string} chars The characters to find.
* @returns {number} Returns the index of the last character not found in `chars`. * @returns {number} Returns the index of the last character not found in `chars`.
*/ */
function charsRightIndex(string, chars) { function charsRightIndex(string, chars) {
@@ -349,7 +349,7 @@
* sort them in ascending order. * sort them in ascending order.
* *
* @private * @private
* @param {Object} value The object to compare to `other`. * @param {Object} object The object to compare to `other`.
* @param {Object} other The object to compare to `object`. * @param {Object} other The object to compare to `object`.
* @returns {number} Returns the sort order indicator for `object`. * @returns {number} Returns the sort order indicator for `object`.
*/ */
@@ -362,7 +362,7 @@
* collection and stable sort them in ascending order. * collection and stable sort them in ascending order.
* *
* @private * @private
* @param {Object} value The object to compare to `other`. * @param {Object} object The object to compare to `other`.
* @param {Object} other The object to compare to `object`. * @param {Object} other The object to compare to `object`.
* @returns {number} Returns the sort order indicator for `object`. * @returns {number} Returns the sort order indicator for `object`.
*/ */
@@ -379,7 +379,7 @@
} }
} }
// Fixes an `Array#sort` bug in the JS engine embedded in Adobe applications // Fixes an `Array#sort` bug in the JS engine embedded in Adobe applications
// that causes it, under certain circumstances, to provided the same value // that causes it, under certain circumstances, to provide the same value
// for `object` and `other`. See https://github.com/jashkenas/underscore/pull/1247 // for `object` and `other`. See https://github.com/jashkenas/underscore/pull/1247
// //
// This also ensures a stable sort in V8 and other engines. // This also ensures a stable sort in V8 and other engines.
@@ -1262,7 +1262,7 @@
} }
/** /**
* The base implementation of `_.find`, '_.findLast`, `_.findKey`, and `_.findLastKey` * The base implementation of `_.find`, `_.findLast`, `_.findKey`, and `_.findLastKey`
* without support for callback shorthands or `this` binding which iterates * without support for callback shorthands or `this` binding which iterates
* over `collection` using the provided `eachFunc`. * over `collection` using the provided `eachFunc`.
* *
@@ -1753,7 +1753,7 @@
* placeholders, and provided arguments into a single array of arguments. * placeholders, and provided arguments into a single array of arguments.
* *
* @private * @private
* @param {Array} partialArg An array of arguments to prepend to those provided. * @param {Array} partialArgs An array of arguments to prepend to those provided.
* @param {Array} partialHolders An array of `partialArgs` placeholder indexes. * @param {Array} partialHolders An array of `partialArgs` placeholder indexes.
* @param {Array|Object} args The provided arguments. * @param {Array|Object} args The provided arguments.
* @returns {Array} Returns the new array of composed arguments. * @returns {Array} Returns the new array of composed arguments.
@@ -1783,7 +1783,7 @@
* is tailored for `_.partialRight`. * is tailored for `_.partialRight`.
* *
* @private * @private
* @param {Array} partialRightArg An array of arguments to append to those provided. * @param {Array} partialRightArgs An array of arguments to append to those provided.
* @param {Array} partialHolders An array of `partialRightArgs` placeholder indexes. * @param {Array} partialHolders An array of `partialRightArgs` placeholder indexes.
* @param {Array|Object} args The provided arguments. * @param {Array|Object} args The provided arguments.
* @returns {Array} Returns the new array of composed arguments. * @returns {Array} Returns the new array of composed arguments.
@@ -2560,7 +2560,7 @@
* @static * @static
* @memberOf _ * @memberOf _
* @category Arrays * @category Arrays
* @param {...Array} [array] The arrays to inspect. * @param {...Array} [arrays] The arrays to inspect.
* @returns {Array} Returns the new array of shared values. * @returns {Array} Returns the new array of shared values.
* @example * @example
* *
@@ -2689,7 +2689,7 @@
* @memberOf _ * @memberOf _
* @category Arrays * @category Arrays
* @param {Array} array The array to modify. * @param {Array} array The array to modify.
* @param {...*} [value] The values to remove. * @param {...*} [values] The values to remove.
* @returns {Array} Returns `array`. * @returns {Array} Returns `array`.
* @example * @example
* *
@@ -3052,7 +3052,7 @@
* @static * @static
* @memberOf _ * @memberOf _
* @category Arrays * @category Arrays
* @param {...Array} [array] The arrays to inspect. * @param {...Array} [arrays] The arrays to inspect.
* @returns {Array} Returns the new array of combined values. * @returns {Array} Returns the new array of combined values.
* @example * @example
* *
@@ -3141,7 +3141,7 @@
* @memberOf _ * @memberOf _
* @category Arrays * @category Arrays
* @param {Array} array The array to filter. * @param {Array} array The array to filter.
* @param {...*} [value] The values to exclude. * @param {...*} [values] The values to exclude.
* @returns {Array} Returns the new array of filtered values. * @returns {Array} Returns the new array of filtered values.
* @example * @example
* *
@@ -3160,7 +3160,7 @@
* @static * @static
* @memberOf _ * @memberOf _
* @category Arrays * @category Arrays
* @param {...Array} [array] The arrays to inspect. * @param {...Array} [arrays] The arrays to inspect.
* @returns {Array} Returns the new array of values. * @returns {Array} Returns the new array of values.
* @example * @example
* *
@@ -3195,7 +3195,7 @@
* @memberOf _ * @memberOf _
* @alias unzip * @alias unzip
* @category Arrays * @category Arrays
* @param {...Array} [array] The arrays to process. * @param {...Array} [arrays] The arrays to process.
* @returns {Array} Returns the array of grouped elements. * @returns {Array} Returns the array of grouped elements.
* @example * @example
* *
@@ -7638,7 +7638,7 @@
} }
/** /**
* Reverts the '_' variable to its previous value and returns a reference to * Reverts the `_` variable to its previous value and returns a reference to
* the `lodash` function. * the `lodash` function.
* *
* @static * @static

19
dist/lodash.underscore.js vendored
View File

@@ -134,7 +134,7 @@
* @private * @private
* @param {*} value The value to compare to `other`. * @param {*} value The value to compare to `other`.
* @param {*} other The value to compare to `value`. * @param {*} other The value to compare to `value`.
* @returns {number} Returns the sort order indicator for `a`. * @returns {number} Returns the sort order indicator for `value`.
*/ */
function baseCompareAscending(value, other) { function baseCompareAscending(value, other) {
if (value !== other) { if (value !== other) {
@@ -174,7 +174,7 @@
* sort them in ascending order. * sort them in ascending order.
* *
* @private * @private
* @param {Object} value The object to compare to `other`. * @param {Object} object The object to compare to `other`.
* @param {Object} other The object to compare to `object`. * @param {Object} other The object to compare to `object`.
* @returns {number} Returns the sort order indicator for `object`. * @returns {number} Returns the sort order indicator for `object`.
*/ */
@@ -611,7 +611,7 @@
} }
/** /**
* The base implementation of `_.find`, '_.findLast`, `_.findKey`, and `_.findLastKey` * The base implementation of `_.find`, `_.findLast`, `_.findKey`, and `_.findLastKey`
* without support for callback shorthands or `this` binding which iterates * without support for callback shorthands or `this` binding which iterates
* over `collection` using the provided `eachFunc`. * over `collection` using the provided `eachFunc`.
* *
@@ -964,7 +964,7 @@
* placeholders, and provided arguments into a single array of arguments. * placeholders, and provided arguments into a single array of arguments.
* *
* @private * @private
* @param {Array} partialArg An array of arguments to prepend to those provided. * @param {Array} partialArgs An array of arguments to prepend to those provided.
* @param {Array} partialHolders An array of `partialArgs` placeholder indexes. * @param {Array} partialHolders An array of `partialArgs` placeholder indexes.
* @param {Array|Object} args The provided arguments. * @param {Array|Object} args The provided arguments.
* @returns {Array} Returns the new array of composed arguments. * @returns {Array} Returns the new array of composed arguments.
@@ -1418,7 +1418,7 @@
* @static * @static
* @memberOf _ * @memberOf _
* @category Arrays * @category Arrays
* @param {...Array} [array] The arrays to inspect. * @param {...Array} [arrays] The arrays to inspect.
* @returns {Array} Returns the new array of shared values. * @returns {Array} Returns the new array of shared values.
* @example * @example
* *
@@ -1683,7 +1683,7 @@
* @static * @static
* @memberOf _ * @memberOf _
* @category Arrays * @category Arrays
* @param {...Array} [array] The arrays to inspect. * @param {...Array} [arrays] The arrays to inspect.
* @returns {Array} Returns the new array of combined values. * @returns {Array} Returns the new array of combined values.
* @example * @example
* *
@@ -1772,7 +1772,7 @@
* @memberOf _ * @memberOf _
* @category Arrays * @category Arrays
* @param {Array} array The array to filter. * @param {Array} array The array to filter.
* @param {...*} [value] The values to exclude. * @param {...*} [values] The values to exclude.
* @returns {Array} Returns the new array of filtered values. * @returns {Array} Returns the new array of filtered values.
* @example * @example
* *
@@ -1793,7 +1793,7 @@
* @memberOf _ * @memberOf _
* @alias unzip * @alias unzip
* @category Arrays * @category Arrays
* @param {...Array} [array] The arrays to process. * @param {...Array} [arrays] The arrays to process.
* @returns {Array} Returns the array of grouped elements. * @returns {Array} Returns the array of grouped elements.
* @example * @example
* *
@@ -4262,6 +4262,7 @@
* *
* @static * @static
* @memberOf _ * @memberOf _
* @type Function
* @category Objects * @category Objects
* @param {Object} object The object to inspect. * @param {Object} object The object to inspect.
* @returns {Array} Returns the array of property names. * @returns {Array} Returns the array of property names.
@@ -4839,7 +4840,7 @@
} }
/** /**
* Reverts the '_' variable to its previous value and returns a reference to * Reverts the `_` variable to its previous value and returns a reference to
* the `lodash` function. * the `lodash` function.
* *
* @static * @static

8
lodash.js
View File

@@ -305,11 +305,11 @@
* collection is a string value. * collection is a string value.
* *
* @private * @private
* @param {string} value The string to inspect. * @param {string} string The string to inspect.
* @returns {number} Returns the code unit of the first character of the string. * @returns {number} Returns the code unit of the first character of the string.
*/ */
function charAtCallback(value) { function charAtCallback(string) {
return value.charCodeAt(0); return string.charCodeAt(0);
} }
/** /**
@@ -4521,7 +4521,7 @@
* @category Collections * @category Collections
* @param {Array|Object|string} collection The collection to sample. * @param {Array|Object|string} collection The collection to sample.
* @param {number} [n] The number of elements to sample. * @param {number} [n] The number of elements to sample.
* @param {Object} [guard] Enables use as a callback for functions like `_.map`. * @param- {Object} [guard] Enables use as a callback for functions like `_.map`.
* @returns {*} Returns the random sample(s). * @returns {*} Returns the random sample(s).
* @example * @example
* *