Skip to content

Commit d457159

Browse files
committed
Minor docs fixes
1 parent 1e891ae commit d457159

43 files changed

Lines changed: 62 additions & 65 deletions

Some content is hidden

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

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -223,8 +223,8 @@ full: true
223223
| [`no-forward-ref`](no-forward-ref) | 1️⃣ 1️⃣ | `🔄` | Replaces usage of `forwardRef` with passing `ref` as a prop | >=19.0.0 |
224224
| [`no-implicit-key`](no-implicit-key) | 1️⃣ 1️⃣ | `🧪` | Prevents `key` from not being explicitly specified (e.g., spreading `key` from objects) | |
225225
| [`no-leaked-conditional-rendering`](no-leaked-conditional-rendering) | 0️⃣ 0️⃣ | `💭` | Prevents problematic leaked values from being rendered | |
226-
| [`no-missing-component-display-name`](no-missing-component-display-name) | 0️⃣ 0️⃣ | | Enforces that all components have a `displayName` that can be used in devtools | |
227-
| [`no-missing-context-display-name`](no-missing-context-display-name) | 0️⃣ 0️⃣ | `🔧` | Enforces that all contexts have a `displayName` that can be used in devtools | |
226+
| [`no-missing-component-display-name`](no-missing-component-display-name) | 0️⃣ 0️⃣ | | Enforces that all components have a `displayName` that can be used in DevTools | |
227+
| [`no-missing-context-display-name`](no-missing-context-display-name) | 0️⃣ 0️⃣ | `🔧` | Enforces that all contexts have a `displayName` that can be used in DevTools | |
228228
| [`no-missing-key`](no-missing-key) | 2️⃣ 2️⃣ | | Disallows missing `key` on items in list rendering | |
229229
| [`no-misused-capture-owner-stack`](no-misused-capture-owner-stack) | 0️⃣ 2️⃣ | `🧪` | Prevents incorrect usage of `captureOwnerStack` | |
230230
| [`no-nested-component-definitions`](no-nested-component-definitions) | 2️⃣ 2️⃣ | | Disallows nesting component definitions inside other components | |

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ react-debug/class-component
1414

1515
## Description
1616

17-
Reports all class components in JSON format. Useful for debugging. This rule should only be used for debugging purposes; otherwise, leave it off.
17+
Reports all class components in JSON format. Useful for debugging. This rule should only be used for debugging purposes; otherwise leave it off.
1818

1919
## Examples
2020

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ react-debug/function-component
1414

1515
## Description
1616

17-
Reports all function components in JSON format. Useful for debugging. This rule should only be used for debugging purposes; otherwise, leave it off.
17+
Reports all function components in JSON format. Useful for debugging. This rule should only be used for debugging purposes; otherwise leave it off.
1818

1919
## Examples
2020

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ react-debug/hook
1414

1515
## Description
1616

17-
Reports all React Hooks in JSON format. Useful for debugging. This rule should be used only for debugging purposes. Otherwise, leave it off.
17+
Reports all React Hooks in JSON format. Useful for debugging. This rule should be used only for debugging purposes; otherwise, leave it off.
1818

1919
## Examples
2020

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ react-debug/is-from-react
1414

1515
## Description
1616

17-
Reports all identifiers initialized from React in JSON format. Useful for debugging. This rule should only be used for debugging purposes. Otherwise, leave it off.
17+
Reports all identifiers initialized from React in JSON format. Useful for debugging. This rule should only be used for debugging purposes; otherwise, leave it off.
1818

1919
## Examples
2020

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ react-debug/is-from-ref
1414

1515
## Description
1616

17-
Reports all identifiers initialized or derived from ref in JSON format. Useful for debugging. This rule should only be used for debugging purposes. Otherwise, leave it off.
17+
Reports all identifiers initialized or derived from refs in JSON format. Useful for debugging. This rule should only be used for debugging purposes; otherwise, leave it off.
1818

1919
## Examples
2020

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ export default createRule<[], MessageID>({
2020
meta: {
2121
type: "problem",
2222
docs: {
23-
description: "Reports all identifiers initialized or derived from ref in JSON format.",
23+
description: "Reports all identifiers initialized or derived from refs in JSON format.",
2424
},
2525
messages: {
2626
isFromRef: "{{json}}",

packages/plugins/eslint-plugin-react-debug/src/rules/jsx.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ react-debug/jsx
1414

1515
## Description
1616

17-
Reports all JSX elements and fragments in JSON format. Useful for debugging. This rule should be used only for debugging purposes; otherwise, leave it off.
17+
Reports all JSX elements and fragments in JSON format. Useful for debugging. This rule should be used only for debugging purposes; otherwise leave it off.
1818

1919
## Examples
2020

packages/plugins/eslint-plugin-react-dom/src/rules/no-missing-iframe-sandbox.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ react-dom/no-missing-iframe-sandbox
2828

2929
Enforces an explicit `sandbox` attribute for `iframe` elements.
3030

31-
The sandbox attribute enables an extra set of restrictions for the content in the iframe. Using sandbox attribute is considered a good security practice.
31+
The sandbox attribute enables an extra set of restrictions for the content in the iframe. Using the sandbox attribute is considered a good security practice.
3232

3333
## Examples
3434

35-
This rule checks all React iframe elements and verifies that there is sandbox attribute and that it's value is valid.
35+
This rule checks all React iframe elements and verifies that there is a `sandbox` attribute and that its value is valid.
3636

3737
### Failing
3838

@@ -72,4 +72,4 @@ function MyComponent() {
7272
- [`no-missing-button-type`](./dom-no-missing-button-type)\
7373
Enforces an explicit `type` attribute for `button` elements.
7474
- [`no-unsafe-iframe-sandbox`](./dom-no-unsafe-iframe-sandbox)\
75-
Enforces `sandbox` attribute for `iframe` elements is not set to unsafe combinations.
75+
Enforces the `sandbox` attribute for `iframe` elements is not set to unsafe combinations.

packages/plugins/eslint-plugin-react-dom/src/rules/no-namespace.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ react-dom/no-namespace
2828

2929
Enforces the absence of a `namespace` in React elements.
3030

31-
Namespaces, such as with `svg:circle` are not supported in React.
31+
Namespaces, such as `svg:circle`, are not supported in React.
3232

3333
## Examples
3434

0 commit comments

Comments
 (0)