Chore: update comment in object-curly-newline

eslint · Jan 23, 2018 · dcef6de · dcef6de
1 parent e4017f7
commit dcef6de
Showing 1 changed file with 9 additions and 10 deletions.
diff --git a/lib/rules/object-curly-newline.js b/lib/rules/object-curly-newline.js
@@ -73,11 +73,13 @@ function normalizeOptionValue(value) {
  * Normalizes a given option value.
  *
  * @param {string|Object|undefined} options - An option value to parse.
- *
- *  TODO:
- *  Update comment
- *
- * @returns {{ObjectExpression: {multiline: boolean, minProperties: number}, ObjectPattern: {multiline: boolean, minProperties: number}}} Normalized option object.
+ * @returns
+ * {{
+ *   ObjectExpression: {multiline: boolean, minProperties: number, consistent: boolean},
+ *   ObjectPattern: {multiline: boolean, minProperties: number, consistent: boolean},
+ *   ImportDeclaration: {multiline: boolean, minProperties: number, consistent: boolean},
+ *   ExportNamedDeclaration : {multiline: boolean, minProperties: number, consistent: boolean}
+ * }} Normalized option object.
  */
 function normalizeOptions(options) {
     if (options &&
@@ -139,11 +141,8 @@ module.exports = {
 
         /**
          * Reports a given node if it violated this rule.
-         *
-         * TODO: UPDATE COMMENT
-         *
-         * @param {ASTNode} node - A node to check. This is an ObjectExpression node or an ObjectPattern node.
-         * @param {{multiline: boolean, minProperties: number}} options - An option object.
+         * @param {ASTNode} node - A node to check. This is an ObjectExpression, ObjectPattern, ImportDeclaration or ExportNamedDeclaration node.
+         * @param {{multiline: boolean, minProperties: number, consistent: boolean}} options - An option object.
          * @returns {void}
          */
         function check(node) {