Skip to content

Commit 6a6f8ff

Browse files
committed
docs: update the description of 'skipImportCheck'
1 parent 0beaadc commit 6a6f8ff

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

apps/website/content/docs/configurations.mdx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,11 @@ import React from "@pika/react";
4949

5050
When determining whether an API originates from React, bypass the import source check.
5151

52-
By default, the rule checks only the shape of the API to determine if it is a React API. If `skipImportCheck` is set to `false`, the rule will check both the shape and the import source.
52+
By default, the rule checks only the shape of the API to determine if it is a React API. If `skipImportCheck` is set to `false`, both the shape and the import source will be checked.
5353

54-
For example, when `skipImportCheck` is set to false, the `memo` function from `unrelated-library` will not be recognized as React's `memo`.
54+
This prevents false positives when using unrelated third-party libraries that have APIs similar to React.
55+
56+
For example, when `skipImportCheck` is set to `false`, the `memo` function from `unrelated-library` will not be recognized as React's `memo`.
5557

5658
```ts
5759
import { memo } from "unrelated-library";

0 commit comments

Comments
 (0)