Skip to content

Commit 2aa00bb

Browse files
committed
docs: minor improvements
1 parent 7300a6b commit 2aa00bb

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

website/pages/docs/configuration.mdx

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import { Config, ESLintConfig } from "#/components/eslint-config";
2+
import { Warning } from "#/components/callout";
23

34
# Configuration
45

@@ -38,14 +39,16 @@ If `importSource` is specified, an equivalent version of React should be provide
3839

3940
(type: `Record<string, string[]>`)
4041

41-
A Record of aliases for React's built-in Hooks. ESLint React will recognize these aliases as equivalent to the built-in Hooks in all its rules.\
42+
A record of aliases for React built-in hooks. ESLint React will recognize these aliases as equivalent to the built-in hooks in all its rules.\
4243
This is intended to cover edge cases. We suggest to use this option very sparingly, if at all.\
4344
(e.g. `{ useLayoutEffect: ["useIsomorphicLayoutEffect"] }`).
4445

4546
### `additionalComponents` (experimental)
4647

47-
A Array of aliases for built-in components. ESLint React will recognize these aliases as equivalent to the built-in components in all its rules.\
48-
This is an experimental feature that can be unstable and lacks comprehensive documentation.\
48+
<Warning>This is an experimental feature that can be unstable and lacks comprehensive documentation.</Warning>
49+
50+
An array of user-defined components, used to inform the ESLint React plugins how to treat these components during checks.\
51+
This is intended to cover edge cases. We suggest to use this option very sparingly, if at all.\
4952

5053
## Examples
5154

0 commit comments

Comments
 (0)