Skip to content

Commit

Permalink
chore: remove unwanted comments from rules markdown (#16054)
Browse files Browse the repository at this point in the history
* chore: fixable comments are no longer needed

* chore: remove reccommended and suggestions from markdowns as well
  • Loading branch information
harish-sethuraman authored Jun 28, 2022
1 parent f50cf43 commit b6aee95
Show file tree
Hide file tree
Showing 164 changed files with 171 additions and 175 deletions.
2 changes: 1 addition & 1 deletion docs/src/rules/array-bracket-newline.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ related_rules:
- array-bracket-spacing
---

<!--FIXABLE-->


Enforces line breaks after opening and before closing array brackets.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/array-bracket-spacing.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ related_rules:
- computed-property-spacing
---

<!--FIXABLE-->


Disallows or enforce spaces inside of brackets.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/array-element-newline.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ related_rules:
- brace-style
---

<!--FIXABLE-->


Enforces line breaks between array elements.

Expand Down
2 changes: 0 additions & 2 deletions docs/src/rules/arrow-body-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/arrow-parens.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ further_reading:
- https://github.com/airbnb/javascript#arrows--one-arg-parens
---

<!--FIXABLE-->


Requires parens in arrow function arguments.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/arrow-spacing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/block-spacing.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ related_rules:
- brace-style
---

<!--FIXABLE-->


Disallows or enforces spaces inside of blocks after opening blocks and before closing blocks.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/brace-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ further_reading:
- https://en.wikipedia.org/wiki/Indent_style
---

<!--FIXABLE-->


Enforces consistent brace style for blocks.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/capitalized-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/comma-dangle.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/comma-spacing.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ further_reading:
- https://dojotoolkit.org/reference-guide/1.9/developer/styleguide.html
---

<!--FIXABLE-->


Enforces spacing around commas.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/comma-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ further_reading:
- https://gist.github.com/isaacs/357981
---

<!--FIXABLE-->


Enforces consistent comma styles.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/computed-property-spacing.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ related_rules:
- space-in-parens
---

<!--FIXABLE-->


Disallows or enforces spaces inside of computed properties.

Expand Down
2 changes: 0 additions & 2 deletions docs/src/rules/constructor-super.md
Original file line number Diff line number Diff line change
Expand Up @@ -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()`.
Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/curly.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/dot-location.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ related_rules:
- dot-notation
---

<!--FIXABLE-->


Enforces newline before and after dots.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/dot-notation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/eol-last.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/eqeqeq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 `!==`.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/for-direction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/func-call-spacing.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ related_rules:
- no-spaced-func
---

<!--FIXABLE-->


Requires or disallows spacing between function identifiers and their invocations.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/function-call-argument-newline.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ related_rules:
- array-element-newline
---

<!--FIXABLE-->


Enforces line breaks between arguments of a function call.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/function-paren-newline.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/generator-star-spacing.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ further_reading:
- https://leanpub.com/understandinges6/read/#leanpub-auto-generators
---

<!--FIXABLE-->


Enforces spacing around the `*` in generator functions.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/getter-return.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/implicit-arrow-linebreak.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ related_rules:
- brace-style
---

<!--FIXABLE-->


Enforces the location of arrow function bodies with implicit returns.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/indent-legacy.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/indent.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/jsx-quotes.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ related_rules:
- quotes
---

<!--FIXABLE-->


Enforces the consistent use of either double or single quotes in JSX attributes.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/key-spacing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/keyword-spacing.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/linebreak-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/lines-around-comment.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ related_rules:
- spaced-comment
---

<!--FIXABLE-->


Requires empty lines around comments.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/lines-around-directive.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ related_rules:
- padded-blocks
---

<!--FIXABLE-->


Requires or disallow newlines around directives.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/lines-between-class-members.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ related_rules:
- padding-line-between-statements
---

<!--FIXABLE-->


Requires or disallows an empty line between class members.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/multiline-comment-style.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/multiline-ternary.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ related_rules:
- operator-linebreak
---

<!--FIXABLE-->


Enforces or disallows newlines between operands of ternary expressions.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/new-parens.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/newline-after-var.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/newline-before-return.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ related_rules:
- newline-after-var
---

<!--FIXABLE-->


Requires an empty line before `return` statements.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/newline-per-chained-call.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/no-async-promise-executor.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/no-case-declarations.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ related_rules:
- no-fallthrough
---

<!--RECOMMENDED-->


Disallows lexical declarations in case/default clauses.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/rules/no-class-assign.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Loading

0 comments on commit b6aee95

Please sign in to comment.