Skip to content

Commit 7c8e062

Browse files
authored
docs: update the rule descriptions to match the docs (#1007)
1 parent 2d86f3c commit 7c8e062

File tree

136 files changed

+219
-231
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

136 files changed

+219
-231
lines changed

.pkgs/eslint-plugin-local/dist/index.js

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,7 @@ function getRequireExpressionArguments(node) {
4949

5050
// src/rules/avoid-multiline-template-expression.ts
5151
var RULE_NAME = "avoid-multiline-template-expression";
52-
var RULE_FEATURES = [
53-
"CHK"
54-
];
52+
var RULE_FEATURES = [];
5553
var avoid_multiline_template_expression_default = createRule({
5654
meta: {
5755
type: "problem",
@@ -82,9 +80,7 @@ var avoid_multiline_template_expression_default = createRule({
8280

8381
// src/rules/no-shadow-underscore.ts
8482
var RULE_NAME2 = "no-shadow-underscore";
85-
var RULE_FEATURES2 = [
86-
"CHK"
87-
];
83+
var RULE_FEATURES2 = [];
8884
var no_shadow_underscore_default = createRule({
8985
meta: {
9086
type: "problem",
@@ -119,7 +115,7 @@ var prefer_eqeq_nullish_comparison_default = createRule({
119115
meta: {
120116
type: "suggestion",
121117
docs: {
122-
description: "enforce eqeqeq preferences around nullish comparisons"
118+
description: "Enforces eqeqeq preferences around nullish comparisons."
123119
},
124120
fixable: "code",
125121
hasSuggestions: true,

.pkgs/eslint-plugin-local/src/rules/prefer-eqeq-nullish-comparison.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ export default createRule({
1616
meta: {
1717
type: "suggestion",
1818
docs: {
19-
description: "enforce eqeqeq preferences around nullish comparisons",
19+
description: "Enforces eqeqeq preferences around nullish comparisons.",
2020
},
2121
fixable: "code",
2222
hasSuggestions: true,

apps/website/content/docs/rules/overview.mdx

Lines changed: 42 additions & 42 deletions

packages/plugins/eslint-plugin-react-debug/src/rules/class-component.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export default createRule<[], MessageID>({
1717
meta: {
1818
type: "problem",
1919
docs: {
20-
description: "report all class components, including anonymous ones",
20+
description: "Reports all class components.",
2121
[Symbol.for("rule_features")]: RULE_FEATURES,
2222
},
2323
messages: {

packages/plugins/eslint-plugin-react-debug/src/rules/function-component.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export default createRule<[], MessageID>({
1717
meta: {
1818
type: "problem",
1919
docs: {
20-
description: "report all function components, including anonymous ones",
20+
description: "Reports all function components.",
2121
[Symbol.for("rule_features")]: RULE_FEATURES,
2222
},
2323
messages: {

packages/plugins/eslint-plugin-react-debug/src/rules/hook.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export default createRule<[], MessageID>({
1717
meta: {
1818
type: "problem",
1919
docs: {
20-
description: "report all React Hooks",
20+
description: "Reports all React Hooks.",
2121
[Symbol.for("rule_features")]: RULE_FEATURES,
2222
},
2323
messages: {

packages/plugins/eslint-plugin-react-debug/src/rules/is-from-react.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ export default createRule<[], MessageID>({
2121
meta: {
2222
type: "problem",
2323
docs: {
24-
description: "report all identifiers that are initialized from React.",
24+
description: "Report all identifiers that are initialized from React.",
2525
[Symbol.for("rule_features")]: RULE_FEATURES,
2626
},
2727
messages: {

packages/plugins/eslint-plugin-react-dom/src/rules/no-dangerously-set-innerhtml-with-children.md

Lines changed: 1 addition & 1 deletion

packages/plugins/eslint-plugin-react-dom/src/rules/no-dangerously-set-innerhtml-with-children.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ export default createRule<[], MessageID>({
1717
meta: {
1818
type: "problem",
1919
docs: {
20-
description: "disallow when a DOM component is using both 'children' and 'dangerouslySetInnerHTML'",
20+
description: "Disallow `dangerouslySetInnerHTML` and `children` at the same time.",
2121
[Symbol.for("rule_features")]: RULE_FEATURES,
2222
},
2323
messages: {

packages/plugins/eslint-plugin-react-dom/src/rules/no-dangerously-set-innerhtml.md

Lines changed: 1 addition & 1 deletion

0 commit comments

Comments
 (0)