Clarify docs of _.matches and _.modArgs methods. [ci skip]

This commit is contained in:
John-David Dalton
2015-10-23 22:12:17 -07:00
parent 3ad67c754f
commit cc8e4956f5

View File

@@ -2874,7 +2874,7 @@
* *
* @private * @private
* @param {string} path The path of the property to get. * @param {string} path The path of the property to get.
* @param {*} srcValue The value to compare. * @param {*} srcValue The value to match.
* @returns {Function} Returns the new function. * @returns {Function} Returns the new function.
*/ */
function baseMatchesProperty(path, srcValue) { function baseMatchesProperty(path, srcValue) {
@@ -8355,7 +8355,7 @@
/** /**
* This method is like `_.modArgs` except that each of the `transforms` is * This method is like `_.modArgs` except that each of the `transforms` is
* provided all arguments the created function is invoked with. * provided the complete set of arguments the created function is invoked with.
* *
* @static * @static
* @memberOf _ * @memberOf _
@@ -12285,9 +12285,9 @@
} }
/** /**
* Creates a function that performs a deep comparison between a given object * Creates a function that performs a deep partial comparison between a given
* and `source`, returning `true` if the given object has equivalent property * object and `source`, returning `true` if the given object has equivalent
* values, else `false`. * property values, else `false`.
* *
* **Note:** This method supports comparing arrays, booleans, `Date` objects, * **Note:** This method supports comparing arrays, booleans, `Date` objects,
* numbers, `Object` objects, regexes, and strings. Objects are compared by * numbers, `Object` objects, regexes, and strings. Objects are compared by
@@ -12314,8 +12314,9 @@
} }
/** /**
* Creates a function that compares the value at `path` of a given object * Creates a function that performs a deep partial comparison between the
* to `srcValue`. * value at `path` of a given object to `srcValue`, returning `true` if the
* object value is equivalent, else `false`.
* *
* **Note:** This method supports comparing arrays, booleans, `Date` objects, * **Note:** This method supports comparing arrays, booleans, `Date` objects,
* numbers, `Object` objects, regexes, and strings. * numbers, `Object` objects, regexes, and strings.