Cleanup doc "returns" for _.assign, _.size, _.defaults, & _.merge. [ci skip]

This commit is contained in:
John-David Dalton
2015-01-05 14:08:19 -08:00
parent 6247bbf4b1
commit 79fec3ac40

View File

@@ -6356,7 +6356,7 @@
* @memberOf _ * @memberOf _
* @category Collection * @category Collection
* @param {Array|Object|string} collection The collection to inspect. * @param {Array|Object|string} collection The collection to inspect.
* @returns {number} Returns `collection.length` or number of own enumerable properties. * @returns {number} Returns the size of `collection`.
* @example * @example
* *
* _.size([1, 2]); * _.size([1, 2]);
@@ -8267,7 +8267,7 @@
* @param {...Object} [sources] The source objects. * @param {...Object} [sources] The source objects.
* @param {Function} [customizer] The function to customize assigning values. * @param {Function} [customizer] The function to customize assigning values.
* @param {*} [thisArg] The `this` binding of `customizer`. * @param {*} [thisArg] The `this` binding of `customizer`.
* @returns {Object} Returns the destination object. * @returns {Object} Returns `object`.
* @example * @example
* *
* _.assign({ 'user': 'barney' }, { 'age': 40 }, { 'user': 'fred', 'status': 'busy' }); * _.assign({ 'user': 'barney' }, { 'age': 40 }, { 'user': 'fred', 'status': 'busy' });
@@ -8333,7 +8333,7 @@
* @category Object * @category Object
* @param {Object} object The destination object. * @param {Object} object The destination object.
* @param {...Object} [sources] The source objects. * @param {...Object} [sources] The source objects.
* @returns {Object} Returns the destination object. * @returns {Object} Returns `object`.
* @example * @example
* *
* _.defaults({ 'user': 'barney' }, { 'age': 36 }, { 'user': 'fred', 'status': 'busy' }); * _.defaults({ 'user': 'barney' }, { 'age': 36 }, { 'user': 'fred', 'status': 'busy' });
@@ -8821,7 +8821,7 @@
* @param {...Object} [sources] The source objects. * @param {...Object} [sources] The source objects.
* @param {Function} [customizer] The function to customize merging properties. * @param {Function} [customizer] The function to customize merging properties.
* @param {*} [thisArg] The `this` binding of `customizer`. * @param {*} [thisArg] The `this` binding of `customizer`.
* @returns {Object} Returns the destination object. * @returns {Object} Returns `object`.
* @example * @example
* *
* var users = { * var users = {