chore: remove unwanted comments from rules markdown (#16054)

* chore: fixable comments are no longer needed * chore: remove reccommended and suggestions from markdowns as well
eslint · Jun 28, 2022 · b6aee95 · b6aee95
1 parent f50cf43
commit b6aee95
Show file tree

Hide file tree

Showing 164 changed files with 171 additions and 175 deletions.
diff --git a/docs/src/rules/array-bracket-newline.md b/docs/src/rules/array-bracket-newline.md
@@ -7,7 +7,7 @@ related_rules:
 - array-bracket-spacing
 ---
 
-<!--FIXABLE-->
+
 
 Enforces line breaks after opening and before closing array brackets.
 

diff --git a/docs/src/rules/array-bracket-spacing.md b/docs/src/rules/array-bracket-spacing.md
@@ -9,7 +9,7 @@ related_rules:
 - computed-property-spacing
 ---
 
-<!--FIXABLE-->
+
 
 Disallows or enforce spaces inside of brackets.
 

diff --git a/docs/src/rules/array-element-newline.md b/docs/src/rules/array-element-newline.md
@@ -14,7 +14,7 @@ related_rules:
 - brace-style
 ---
 
-<!--FIXABLE-->
+
 
 Enforces line breaks between array elements.
 

diff --git a/docs/src/rules/arrow-body-style.md b/docs/src/rules/arrow-body-style.md
@@ -5,8 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/arrow-body-
 rule_type: suggestion
 ---
 
-<!--FIXABLE-->
-
 Requires braces in arrow function bodies.
 
 Arrow functions have two syntactic forms for their function bodies.  They may be defined with a *block* body (denoted by curly braces) `() => { ... }` or with a single expression `() => ...`, whose value is implicitly returned.

diff --git a/docs/src/rules/arrow-parens.md b/docs/src/rules/arrow-parens.md
@@ -7,7 +7,7 @@ further_reading:
 - https://github.com/airbnb/javascript#arrows--one-arg-parens
 ---
 
-<!--FIXABLE-->
+
 
 Requires parens in arrow function arguments.
 

diff --git a/docs/src/rules/arrow-spacing.md b/docs/src/rules/arrow-spacing.md
@@ -5,7 +5,7 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/arrow-spaci
 rule_type: layout
 ---
 
-<!--FIXABLE-->
+
 
 Requires space before/after arrow function's arrow.
 

diff --git a/docs/src/rules/block-spacing.md b/docs/src/rules/block-spacing.md
@@ -8,7 +8,7 @@ related_rules:
 - brace-style
 ---
 
-<!--FIXABLE-->
+
 
 Disallows or enforces spaces inside of blocks after opening blocks and before closing blocks.
 

diff --git a/docs/src/rules/brace-style.md b/docs/src/rules/brace-style.md
@@ -10,7 +10,7 @@ further_reading:
 - https://en.wikipedia.org/wiki/Indent_style
 ---
 
-<!--FIXABLE-->
+
 
 Enforces consistent brace style for blocks.
 

diff --git a/docs/src/rules/capitalized-comments.md b/docs/src/rules/capitalized-comments.md
@@ -5,7 +5,7 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/capitalized
 rule_type: suggestion
 ---
 
-<!--FIXABLE-->
+
 
 Enforces or disallows capitalization of the first letter of a comment.
 

diff --git a/docs/src/rules/comma-dangle.md b/docs/src/rules/comma-dangle.md
@@ -5,7 +5,7 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/comma-dangl
 rule_type: layout
 ---
 
-<!--FIXABLE-->
+
 
 Requires or disallows trailing commas.
 

diff --git a/docs/src/rules/comma-spacing.md b/docs/src/rules/comma-spacing.md
@@ -17,7 +17,7 @@ further_reading:
 - https://dojotoolkit.org/reference-guide/1.9/developer/styleguide.html
 ---
 
-<!--FIXABLE-->
+
 
 Enforces spacing around commas.
 

diff --git a/docs/src/rules/comma-style.md b/docs/src/rules/comma-style.md
@@ -9,7 +9,7 @@ further_reading:
 - https://gist.github.com/isaacs/357981
 ---
 
-<!--FIXABLE-->
+
 
 Enforces consistent comma styles.
 

diff --git a/docs/src/rules/computed-property-spacing.md b/docs/src/rules/computed-property-spacing.md
@@ -9,7 +9,7 @@ related_rules:
 - space-in-parens
 ---
 
-<!--FIXABLE-->
+
 
 Disallows or enforces spaces inside of computed properties.
 

diff --git a/docs/src/rules/constructor-super.md b/docs/src/rules/constructor-super.md
@@ -5,8 +5,6 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/constructor
 rule_type: problem
 ---
 
-<!--RECOMMENDED-->
-
 Verifies calls of `super()` in constructors.
 
 Constructors of derived classes must call `super()`.

diff --git a/docs/src/rules/curly.md b/docs/src/rules/curly.md
@@ -5,7 +5,7 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/curly.md
 rule_type: suggestion
 ---
 
-<!--FIXABLE-->
+
 
 Requires following curly brace conventions.
 

diff --git a/docs/src/rules/dot-location.md b/docs/src/rules/dot-location.md
@@ -8,7 +8,7 @@ related_rules:
 - dot-notation
 ---
 
-<!--FIXABLE-->
+
 
 Enforces newline before and after dots.
 

diff --git a/docs/src/rules/dot-notation.md b/docs/src/rules/dot-notation.md
@@ -5,7 +5,7 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/dot-notatio
 rule_type: suggestion
 ---
 
-<!--FIXABLE-->
+
 
 Enforces dot notation whenever possible.
 

diff --git a/docs/src/rules/eol-last.md b/docs/src/rules/eol-last.md
@@ -5,7 +5,7 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/eol-last.md
 rule_type: layout
 ---
 
-<!--FIXABLE-->
+
 
 Requires or disallows newline at the end of files.
 

diff --git a/docs/src/rules/eqeqeq.md b/docs/src/rules/eqeqeq.md
@@ -5,7 +5,7 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/eqeqeq.md
 rule_type: suggestion
 ---
 
-<!--FIXABLE-->
+
 
 Requires the use of `===` and `!==`.
 

diff --git a/docs/src/rules/for-direction.md b/docs/src/rules/for-direction.md
@@ -5,7 +5,7 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/for-directi
 rule_type: problem
 ---
 
-<!--RECOMMENDED-->
+
 
 Enforces `for` loop update clause moving the counter in the right direction.
 

diff --git a/docs/src/rules/func-call-spacing.md b/docs/src/rules/func-call-spacing.md
@@ -7,7 +7,7 @@ related_rules:
 - no-spaced-func
 ---
 
-<!--FIXABLE-->
+
 
 Requires or disallows spacing between function identifiers and their invocations.
 

diff --git a/docs/src/rules/function-call-argument-newline.md b/docs/src/rules/function-call-argument-newline.md
@@ -10,7 +10,7 @@ related_rules:
 - array-element-newline
 ---
 
-<!--FIXABLE-->
+
 
 Enforces line breaks between arguments of a function call.
 

diff --git a/docs/src/rules/function-paren-newline.md b/docs/src/rules/function-paren-newline.md
@@ -5,7 +5,7 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/function-pa
 rule_type: layout
 ---
 
-<!--FIXABLE-->
+
 
 Enforces consistent line breaks inside function parentheses.
 

diff --git a/docs/src/rules/generator-star-spacing.md b/docs/src/rules/generator-star-spacing.md
@@ -7,7 +7,7 @@ further_reading:
 - https://leanpub.com/understandinges6/read/#leanpub-auto-generators
 ---
 
-<!--FIXABLE-->
+
 
 Enforces spacing around the `*` in generator functions.
 

diff --git a/docs/src/rules/getter-return.md b/docs/src/rules/getter-return.md
@@ -8,7 +8,7 @@ further_reading:
 - https://leanpub.com/understandinges6/read/#leanpub-auto-accessor-properties
 ---
 
-<!--RECOMMENDED-->
+
 
 Enforces that a `return` statement is present in property getters.
 

diff --git a/docs/src/rules/implicit-arrow-linebreak.md b/docs/src/rules/implicit-arrow-linebreak.md
@@ -7,7 +7,7 @@ related_rules:
 - brace-style
 ---
 
-<!--FIXABLE-->
+
 
 Enforces the location of arrow function bodies with implicit returns.
 

diff --git a/docs/src/rules/indent-legacy.md b/docs/src/rules/indent-legacy.md
@@ -5,7 +5,7 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/indent-lega
 rule_type: layout
 ---
 
-<!--FIXABLE-->
+
 
 Enforces consistent indentation.
 

diff --git a/docs/src/rules/indent.md b/docs/src/rules/indent.md
@@ -5,7 +5,7 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/indent.md
 rule_type: layout
 ---
 
-<!--FIXABLE-->
+
 
 Enforces consistent indentation.
 

diff --git a/docs/src/rules/jsx-quotes.md b/docs/src/rules/jsx-quotes.md
@@ -7,7 +7,7 @@ related_rules:
 - quotes
 ---
 
-<!--FIXABLE-->
+
 
 Enforces the consistent use of either double or single quotes in JSX attributes.
 

diff --git a/docs/src/rules/key-spacing.md b/docs/src/rules/key-spacing.md
@@ -5,7 +5,7 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/key-spacing
 rule_type: layout
 ---
 
-<!--FIXABLE-->
+
 
 Enforces consistent spacing between keys and values in object literal properties.
 

diff --git a/docs/src/rules/keyword-spacing.md b/docs/src/rules/keyword-spacing.md
@@ -5,7 +5,7 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/keyword-spa
 rule_type: layout
 ---
 
-<!--FIXABLE-->
+
 
 Enforces consistent spacing before and after keywords.
 

diff --git a/docs/src/rules/linebreak-style.md b/docs/src/rules/linebreak-style.md
@@ -5,7 +5,7 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/linebreak-s
 rule_type: layout
 ---
 
-<!--FIXABLE-->
+
 
 Enforces consistent linebreak style.
 

diff --git a/docs/src/rules/lines-around-comment.md b/docs/src/rules/lines-around-comment.md
@@ -8,7 +8,7 @@ related_rules:
 - spaced-comment
 ---
 
-<!--FIXABLE-->
+
 
 Requires empty lines around comments.
 

diff --git a/docs/src/rules/lines-around-directive.md b/docs/src/rules/lines-around-directive.md
@@ -8,7 +8,7 @@ related_rules:
 - padded-blocks
 ---
 
-<!--FIXABLE-->
+
 
 Requires or disallow newlines around directives.
 

diff --git a/docs/src/rules/lines-between-class-members.md b/docs/src/rules/lines-between-class-members.md
@@ -8,7 +8,7 @@ related_rules:
 - padding-line-between-statements
 ---
 
-<!--FIXABLE-->
+
 
 Requires or disallows an empty line between class members.
 

diff --git a/docs/src/rules/multiline-comment-style.md b/docs/src/rules/multiline-comment-style.md
@@ -5,7 +5,7 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/multiline-c
 rule_type: suggestion
 ---
 
-<!--FIXABLE-->
+
 
 Enforces a particular style for multiline comments.
 

diff --git a/docs/src/rules/multiline-ternary.md b/docs/src/rules/multiline-ternary.md
@@ -7,7 +7,7 @@ related_rules:
 - operator-linebreak
 ---
 
-<!--FIXABLE-->
+
 
 Enforces or disallows newlines between operands of ternary expressions.
 

diff --git a/docs/src/rules/new-parens.md b/docs/src/rules/new-parens.md
@@ -5,7 +5,7 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/new-parens.
 rule_type: layout
 ---
 
-<!--FIXABLE-->
+
 
 Requires parentheses when invoking a constructor with no arguments.
 

diff --git a/docs/src/rules/newline-after-var.md b/docs/src/rules/newline-after-var.md
@@ -5,7 +5,7 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/newline-aft
 rule_type: layout
 ---
 
-<!--FIXABLE-->
+
 
 Requires or disallows an empty line after variable declarations.
 

diff --git a/docs/src/rules/newline-before-return.md b/docs/src/rules/newline-before-return.md
@@ -7,7 +7,7 @@ related_rules:
 - newline-after-var
 ---
 
-<!--FIXABLE-->
+
 
 Requires an empty line before `return` statements.
 

diff --git a/docs/src/rules/newline-per-chained-call.md b/docs/src/rules/newline-per-chained-call.md
@@ -5,7 +5,7 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/newline-per
 rule_type: layout
 ---
 
-<!--FIXABLE-->
+
 
 Requires a newline after each call in a method chain.
 

diff --git a/docs/src/rules/no-async-promise-executor.md b/docs/src/rules/no-async-promise-executor.md
@@ -5,7 +5,7 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-async-pr
 rule_type: problem
 ---
 
-<!--RECOMMENDED-->
+
 
 Disallows using an async function as a Promise executor.
 

diff --git a/docs/src/rules/no-case-declarations.md b/docs/src/rules/no-case-declarations.md
@@ -7,7 +7,7 @@ related_rules:
 - no-fallthrough
 ---
 
-<!--RECOMMENDED-->
+
 
 Disallows lexical declarations in case/default clauses.
 

diff --git a/docs/src/rules/no-class-assign.md b/docs/src/rules/no-class-assign.md
@@ -5,7 +5,7 @@ edit_link: https://github.com/eslint/eslint/edit/main/docs/src/rules/no-class-as
 rule_type: problem
 ---
 
-<!--RECOMMENDED-->
+
 
 Disallows modifying variables of class declarations.