chore: Update no-comments rule ID and description

Author: tomerh2001

README.md

@@ -29,78 +29,3 @@ This repository contains custom ESLint rules to enhance code quality and consist
 ### 1. No-destructuring Rule
 
 **Rule ID:** `th-rules/no-destructuring`
-
-#### Description
-
-This rule disallows destructuring that does not meet certain conditions, aiming to prevent overly complex destructuring patterns and ensure code readability.
-
-#### Rule Details
-
-This rule checks for:
-
-- Destructuring at a nesting level above 3.
-- Destructuring of more than the specified maximum number of variables (default is 2).
-- Destructuring on a line exceeding the specified maximum line length (default is 100 characters).
-
-#### Configuration
-
-```json
-{
-  "rules": {
-    "th-rules/no-destructuring": ["error", { "maximumDestructuredVariables": 2, "maximumLineLength": 100 }]
-  }
-}
-```
-
-### 2. Name-Export Rule
-
-**Rule ID:** `th-rules/no-default-export`
-
-#### Description
-
-Converts unnamed default exports to named default exports based on the file name. This rule helps maintain consistency in export names and facilitates easier identification of components or modules.
-
-#### Rule Details
-
-This rule targets unnamed default exports and automatically generates a named export based on the file name.
-
-#### Configuration
-```json
-{
-  "rules": {
-    "no-default-export": "error"
-  }
-}
-```
-### 3. No-Comments Rule
-
-**Rule ID:** `th-rules/no-comments`
-
-#### Description
-
-This rule disallows comments unless they match specified allowed patterns. It ensures that only relevant and permitted comments are present in the codebase, such as TODOs, warnings, JSDoc comments, ESLint directives, etc.
-
-#### Rule Details
-
-By default, the following comments are allowed:
-
-- TODO, WARNING, ERROR, INFO (case-insensitive).
-- ESLint directives like `/* eslint-disable */`.
-- JSDoc comments (any comment starting with `/**`).
-
-You can also configure additional patterns to allow or disallow specific types of comments.
-
-#### Configuration
-
-```json
-{
-  "rules": {
-    "th-rules/no-comments": [
-      "error",
-      {
-        "allow": ["keep", "important"],
-        "disallow": ["deprecated", "hack"]
-      }
-    ]
-  }
-}

docs/rules/no-comments.md

@@ -16,3 +16,33 @@
 | `disallow` | Additional patterns to disallow in comments. | String[] |
 
 <!-- end auto-generated rule options list -->
+
+#### Description
+
+This rule disallows comments unless they match specified allowed patterns. It ensures that only relevant and permitted comments are present in the codebase, such as TODOs, warnings, JSDoc comments, ESLint directives, etc.
+
+#### Rule Details
+
+By default, the following comments are allowed:
+
+- TODO, WARNING, ERROR, INFO (case-insensitive).
+- ESLint directives like `/* eslint-disable */`.
+- JSDoc comments (any comment starting with `/**`).
+
+You can also configure additional patterns to allow or disallow specific types of comments.
+
+#### Usage
+
+```json
+{
+  "rules": {
+    "th-rules/no-comments": [
+      "error",
+      {
+        "allow": ["keep", "important"],
+        "disallow": ["deprecated", "hack"]
+      }
+    ]
+  }
+}
+```

docs/rules/no-default-export.md

@@ -5,3 +5,20 @@
 🔧 This rule is automatically fixable by the [`--fix` CLI option](https://eslint.org/docs/latest/user-guide/command-line-interface#--fix).
 
 <!-- end auto-generated rule header -->
+
+#### Description
+
+Converts unnamed default exports to named default exports based on the file name. This rule helps maintain consistency in export names and facilitates easier identification of components or modules.
+
+#### Rule Details
+
+This rule targets unnamed default exports and automatically generates a named export based on the file name.
+
+#### Usage
+```json
+{
+  "rules": {
+    "no-default-export": "error"
+  }
+}
+```

docs/rules/no-destructuring.md

@@ -14,3 +14,25 @@
 | `maximumLineLength`            | Integer |
 
 <!-- end auto-generated rule options list -->
+
+#### Description
+
+This rule disallows destructuring that does not meet certain conditions, aiming to prevent overly complex destructuring patterns and ensure code readability.
+
+#### Rule Details
+
+This rule checks for:
+
+- Destructuring at a nesting level above 3.
+- Destructuring of more than the specified maximum number of variables (default is 2).
+- Destructuring on a line exceeding the specified maximum line length (default is 100 characters).
+
+#### Usage
+
+```json
+{
+  "rules": {
+    "th-rules/no-destructuring": ["error", { "maximumDestructuredVariables": 2, "maximumLineLength": 100 }]
+  }
+}
+```