docs(NgModelController): clarify the value parameter for $isEmpty

petebacondarwin · petebacondarwin · commit 42d09f1772ae · 2014-11-23T15:24:36.000Z
diff --git a/src/ng/directive/input.js b/src/ng/directive/input.js
@@ -1814,17 +1814,18 @@ var NgModelController = ['$scope', '$exceptionHandler', '$attrs', '$element', '$
    * @name ngModel.NgModelController#$isEmpty
    *
    * @description
-   * This is called when we need to determine if the value of the input is empty.
+   * This is called when we need to determine if the value of an input is empty.
    *
    * For instance, the required directive does this to work out if the input has data or not.
+   *
    * The default `$isEmpty` function checks whether the value is `undefined`, `''`, `null` or `NaN`.
    *
    * You can override this for input directives whose concept of being empty is different to the
    * default. The `checkboxInputType` directive does this because in its case a value of `false`
    * implies empty.
    *
-   * @param {*} value Reference to check.
-   * @returns {boolean} True if `value` is empty.
+   * @param {*} value The value of the input to check for emptiness.
+   * @returns {boolean} True if `value` is "empty".
    */
   this.$isEmpty = function(value) {
     return isUndefined(value) || value === '' || value === null || value !== value;

Original file line number	Diff line number	Diff line change
`@@ -1814,17 +1814,18 @@ var NgModelController = ['$scope', '$exceptionHandler', '$attrs', '$element', '$`
`1814`	`1814`	`* @name ngModel.NgModelController#$isEmpty`
`1815`	`1815`	`*`
`1816`	`1816`	`* @description`
`1817`		`- * This is called when we need to determine if the value of the input is empty.`
	`1817`	`+ * This is called when we need to determine if the value of an input is empty.`
`1818`	`1818`	`*`
`1819`	`1819`	`* For instance, the required directive does this to work out if the input has data or not.`
	`1820`	`+ *`
`1820`	`1821`	* The default `$isEmpty` function checks whether the value is `undefined`, `''`, `null` or `NaN`.
`1821`	`1822`	`*`
`1822`	`1823`	`* You can override this for input directives whose concept of being empty is different to the`
`1823`	`1824`	* default. The `checkboxInputType` directive does this because in its case a value of `false`
`1824`	`1825`	`* implies empty.`
`1825`	`1826`	`*`
`1826`		`- * @param {*} value Reference to check.`
`1827`		- * @returns {boolean} True if `value` is empty.
	`1827`	`+ * @param {*} value The value of the input to check for emptiness.`
	`1828`	+ * @returns {boolean} True if `value` is "empty".
`1828`	`1829`	`*/`
`1829`	`1830`	`this.$isEmpty = function(value) {`
`1830`	`1831`	`return isUndefined(value) \|\| value === '' \|\| value === null \|\| value !== value;`