More doc tweaks/cleanup. [ci skip].

This commit is contained in:
John-David Dalton
2013-10-13 18:06:23 -07:00
parent 1f8e1d2a29
commit dc6b1ef47b

View File

@@ -1973,15 +1973,15 @@
* @returns {Object} Returns the destination object. * @returns {Object} Returns the destination object.
* @example * @example
* *
* _.assign({ 'name': 'fred' }, { 'age': 40 }); * _.assign({ 'name': 'fred' }, { 'employer': 'slate' });
* // => { 'name': 'fred', 'age': 40 } * // => { 'name': 'fred', 'employer': 'slate' }
* *
* var defaults = _.partialRight(_.assign, function(a, b) { * var defaults = _.partialRight(_.assign, function(a, b) {
* return typeof a == 'undefined' ? b : a; * return typeof a == 'undefined' ? b : a;
* }); * });
* *
* var person = { 'name': 'barney' }; * var object = { 'name': 'barney' };
* defaults(person, { 'name': 'fred', 'employer': 'slate' }); * defaults(object, { 'name': 'fred', 'employer': 'slate' });
* // => { 'name': 'barney', 'employer': 'slate' } * // => { 'name': 'barney', 'employer': 'slate' }
*/ */
var assign = createIterator(defaultsIteratorOptions, { var assign = createIterator(defaultsIteratorOptions, {
@@ -2109,8 +2109,8 @@
* @returns {Object} Returns the destination object. * @returns {Object} Returns the destination object.
* @example * @example
* *
* var person = { 'name': 'barney' }; * var object = { 'name': 'barney' };
* _.defaults(person, { 'name': 'fred', 'employer': 'slate' }); * _.defaults(object, { 'name': 'fred', 'employer': 'slate' });
* // => { 'name': 'barney', 'employer': 'slate' } * // => { 'name': 'barney', 'employer': 'slate' }
*/ */
var defaults = createIterator(defaultsIteratorOptions); var defaults = createIterator(defaultsIteratorOptions);
@@ -2530,13 +2530,13 @@
* @returns {boolean} Returns `true` if the values are equivalent, else `false`. * @returns {boolean} Returns `true` if the values are equivalent, else `false`.
* @example * @example
* *
* var fred = { 'name': 'fred', 'age': 40 }; * var object = { 'name': 'fred' };
* var copy = { 'name': 'fred', 'age': 40 }; * var copy = { 'name': 'fred' };
* *
* fred == copy; * object == copy;
* // => false * // => false
* *
* _.isEqual(fred, copy); * _.isEqual(object, copy);
* // => true * // => true
* *
* var words = ['hello', 'goodbye']; * var words = ['hello', 'goodbye'];
@@ -5359,11 +5359,11 @@
* // => 'hi fred' * // => 'hi fred'
* *
* object.greet = function(greeting) { * object.greet = function(greeting) {
* return greeting + ', ' + this.name + '!'; * return greeting + 'ya ' + this.name + '!';
* }; * };
* *
* func(); * func();
* // => 'hi, fred!' * // => 'hiya fred!'
*/ */
function bindKey(object, key) { function bindKey(object, key) {
return arguments.length > 2 return arguments.length > 2
@@ -5957,8 +5957,8 @@
* @returns {*} Returns `value`. * @returns {*} Returns `value`.
* @example * @example
* *
* var fred = { 'name': 'fred' }; * var object = { 'name': 'fred' };
* fred === _.identity(fred); * object === _.identity(object);
* // => true * // => true
*/ */
function identity(value) { function identity(value) {