Cleanup docs of _.flow, _.flowRight, _.defaults, _.range, _.inRange, & _.sum. [ci skip]

This commit is contained in:
jdalton
2015-02-28 21:12:10 -08:00
parent d860cf834d
commit 1af8b9d16a

View File

@@ -7500,15 +7500,11 @@
* @returns {Function} Returns the new function. * @returns {Function} Returns the new function.
* @example * @example
* *
* function add(x, y) {
* return x + y;
* }
*
* function square(n) { * function square(n) {
* return n * n; * return n * n;
* } * }
* *
* var addSquare = _.flow(add, square); * var addSquare = _.flow(_.add, square);
* addSquare(1, 2); * addSquare(1, 2);
* // => 9 * // => 9
*/ */
@@ -7545,15 +7541,11 @@
* @returns {Function} Returns the new function. * @returns {Function} Returns the new function.
* @example * @example
* *
* function add(x, y) {
* return x + y;
* }
*
* function square(n) { * function square(n) {
* return n * n; * return n * n;
* } * }
* *
* var addSquare = _.flowRight(square, add); * var addSquare = _.flowRight(square, _.add);
* addSquare(1, 2); * addSquare(1, 2);
* // => 9 * // => 9
*/ */
@@ -8783,7 +8775,7 @@
/** /**
* Assigns own enumerable properties of source object(s) to the destination * Assigns own enumerable properties of source object(s) to the destination
* object for all destination properties that resolve to `undefined`. Once a * object for all destination properties that resolve to `undefined`. Once a
* property is set, additional defaults of the same property are ignored. * property is set, additional values of the same property are ignored.
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -9602,7 +9594,7 @@
/** /**
* Checks if `n` is between `start` and up to but not including, `end`. If * Checks if `n` is between `start` and up to but not including, `end`. If
* `end` is not specified it defaults to `start` with `start` becoming `0`. * `end` is not specified it is set to `start` with `start` then set to `0`.
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -10939,9 +10931,9 @@
/** /**
* Creates an array of numbers (positive and/or negative) progressing from * Creates an array of numbers (positive and/or negative) progressing from
* `start` up to, but not including, `end`. If `end` is not specified it * `start` up to, but not including, `end`. If `end` is not specified it is
* defaults to `start` with `start` becoming `0`. If `start` is less than * set to `start` with `start` then set to `0`. If `start` is less than `end`
* `end` a zero-length range is created unless a negative `step` is specified. * a zero-length range is created unless a negative `step` is specified.
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -11185,13 +11177,13 @@
var min = createExtremum(arrayMin, true); var min = createExtremum(arrayMin, true);
/** /**
* Gets the sum of `collection` values. * Gets the sum of the values in `collection`.
* *
* @static * @static
* @memberOf _ * @memberOf _
* @category Math * @category Math
* @param {Array|Object|string} collection The collection to iterate over. * @param {Array|Object|string} collection The collection to iterate over.
* @returns {number} Returns the sum of values. * @returns {number} Returns the sum.
* @example * @example
* *
* _.sum([4, 6, 2]); * _.sum([4, 6, 2]);