docs: update JSDoc

moeriki · Jul 13, 2020 · f52dd00 · f52dd00
1 parent a9f7474
commit f52dd00
Showing 1 changed file with 2 additions and 3 deletions.
diff --git a/lib/rules/no-magic-numbers.js b/lib/rules/no-magic-numbers.js
@@ -96,10 +96,9 @@ module.exports = {
         }
 
         /**
-         * Returns whether the number should be ignored when used as a default
-         * value assignment.
+         * Returns whether the number is a default value assignment.
          * @param {ASTNode} fullNumberNode `Literal` or `UnaryExpression` full number node
-         * @returns {boolean} true if the number should be ignored
+         * @returns {boolean} true if the number is a default value
          */
         function isDefaultValue(fullNumberNode) {
             const parent = fullNumberNode.parent;