More doc tweaks. [ci skip]

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

40
dist/lodash.js vendored
View File

@@ -246,7 +246,7 @@
* @private
* @param {*} value The value to compare to `other`.
* @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) {
if (value !== other) {
@@ -299,11 +299,11 @@
* collection is a string value.
*
* @private
* @param {string} value The character to inspect.
* @returns {number} Returns the code unit of the given character.
* @param {string} string The string to inspect.
* @returns {number} Returns the code unit of the first character of the string.
*/
function charAtCallback(value) {
return value.charCodeAt(0);
function charAtCallback(string) {
return string.charCodeAt(0);
}
/**
@@ -311,7 +311,7 @@
*
* @private
* @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`.
*/
function charsLeftIndex(string, chars) {
@@ -331,7 +331,7 @@
*
* @private
* @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`.
*/
function charsRightIndex(string, chars) {
@@ -349,7 +349,7 @@
* sort them in ascending order.
*
* @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`.
* @returns {number} Returns the sort order indicator for `object`.
*/
@@ -362,7 +362,7 @@
* collection and stable sort them in ascending order.
*
* @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`.
* @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
// 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
//
// 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
* over `collection` using the provided `eachFunc`.
*
@@ -1753,7 +1753,7 @@
* placeholders, and provided arguments into a single array of arguments.
*
* @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|Object} args The provided arguments.
* @returns {Array} Returns the new array of composed arguments.
@@ -1783,7 +1783,7 @@
* is tailored for `_.partialRight`.
*
* @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|Object} args The provided arguments.
* @returns {Array} Returns the new array of composed arguments.
@@ -2560,7 +2560,7 @@
* @static
* @memberOf _
* @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.
* @example
*
@@ -2689,7 +2689,7 @@
* @memberOf _
* @category Arrays
* @param {Array} array The array to modify.
* @param {...*} [value] The values to remove.
* @param {...*} [values] The values to remove.
* @returns {Array} Returns `array`.
* @example
*
@@ -3052,7 +3052,7 @@
* @static
* @memberOf _
* @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.
* @example
*
@@ -3141,7 +3141,7 @@
* @memberOf _
* @category Arrays
* @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.
* @example
*
@@ -3160,7 +3160,7 @@
* @static
* @memberOf _
* @category Arrays
* @param {...Array} [array] The arrays to inspect.
* @param {...Array} [arrays] The arrays to inspect.
* @returns {Array} Returns the new array of values.
* @example
*
@@ -3195,7 +3195,7 @@
* @memberOf _
* @alias unzip
* @category Arrays
* @param {...Array} [array] The arrays to process.
* @param {...Array} [arrays] The arrays to process.
* @returns {Array} Returns the array of grouped elements.
* @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.
*
* @static