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

Doc tweaks for boolean params. [ci skip]

Browse Source
This commit is contained in:
John-David Dalton
2014-06-17 09:16:09 -07:00
parent 0d2db28908
commit 00e00eb7b5
1 changed files with 8 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
lodash.js
View File

@@ -798,7 +798,7 @@
* *
* @private * @private
* @param {*} value The value to wrap in a `lodash` instance. * @param {*} value The value to wrap in a `lodash` instance.
* @param {boolean} [chainAll=false] A flag to enable chaining for all methods. * @param {boolean} [chainAll=false] Enable chaining for all methods.
* @returns {Object} Returns a `lodash` instance. * @returns {Object} Returns a `lodash` instance.
*/ */
function lodashWrapper(value, chainAll) { function lodashWrapper(value, chainAll) {
@@ -1565,8 +1565,8 @@
* @param {Array|Object|string} collection The collection to search. * @param {Array|Object|string} collection The collection to search.
* @param {Function} predicate The function called per iteration. * @param {Function} predicate The function called per iteration.
* @param {Function} eachFunc The function to iterate over the collection. * @param {Function} eachFunc The function to iterate over the collection.
* @param {boolean} [retKey=false] A flag to indicate returning the key of * @param {boolean} [retKey=false] Specify returning the key of the found
* the found element instead of the element itself. * element instead of the element itself.
* @returns {*} Returns the found element or its key, else `undefined`. * @returns {*} Returns the found element or its key, else `undefined`.
*/ */
function baseFind(collection, predicate, eachFunc, retKey) { function baseFind(collection, predicate, eachFunc, retKey) {
@@ -1587,8 +1587,8 @@
* *
* @private * @private
* @param {Array} array The array to flatten. * @param {Array} array The array to flatten.
* @param {boolean} [isShallow=false] A flag to restrict flattening to a single level. * @param {boolean} [isDeep=false] Specify a deep flatten.
* @param {boolean} [isStrict=false] A flag to restrict flattening to arrays and `arguments` objects. * @param {boolean} [isStrict=false] Restrict flattening to arrays and `arguments` objects.
* @param {number} [fromIndex=0] The index to start from. * @param {number} [fromIndex=0] The index to start from.
* @returns {Array} Returns the new flattened array. * @returns {Array} Returns the new flattened array.
*/ */
@@ -1741,7 +1741,7 @@
* @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`.
* @param {Function} [callback] The function to customize comparing values. * @param {Function} [callback] The function to customize comparing values.
* @param {boolean} [isWhere=false] A flag to indicate performing partial comparisons. * @param {boolean} [isWhere=false] Specify performing partial comparisons.
* @param {Array} [stackA=[]] Tracks traversed `value` objects. * @param {Array} [stackA=[]] Tracks traversed `value` objects.
* @param {Array} [stackB=[]] Tracks traversed `other` objects. * @param {Array} [stackB=[]] Tracks traversed `other` objects.
* @returns {boolean} Returns `true` if the values are equivalent, else `false`. * @returns {boolean} Returns `true` if the values are equivalent, else `false`.
@@ -2092,7 +2092,7 @@
* *
* @private * @private
* @param {Array} array The array to inspect. * @param {Array} array The array to inspect.
* @param {boolean} [isSorted=false] A flag to indicate that `array` is sorted. * @param {boolean} [isSorted=false] Specify the array is sorted.
* @param {Function} [callback] The function called per iteration. * @param {Function} [callback] The function called per iteration.
* @returns {Array} Returns the new duplicate-value-free array. * @returns {Array} Returns the new duplicate-value-free array.
*/ */
@@ -3686,7 +3686,7 @@
* @alias unique * @alias unique
* @category Arrays * @category Arrays
* @param {Array} array The array to inspect. * @param {Array} array The array to inspect.
* @param {boolean} [isSorted=false] A flag to indicate that `array` is sorted. * @param {boolean} [isSorted=false] Specify the array is sorted.
* @param {Function|Object|string} [callback] The function called per iteration. * @param {Function|Object|string} [callback] The function called per iteration.
* If a property name or object is provided it is used to create a "_.pluck" * If a property name or object is provided it is used to create a "_.pluck"
* or "_.where" style callback respectively. * or "_.where" style callback respectively.