Skip to content

Commit

Permalink
Adds a section to the README for the new setting
Browse files Browse the repository at this point in the history
  • Loading branch information
Daverball committed Dec 12, 2024
1 parent 1136e55 commit 76d4b9c
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,24 @@ pip install flake8-type-checking

These options are configurable, and can be set in your flake8 config.

### Typing modules

If you re-export `typing` or `typing_extensions` members from a compatibility
module, you will need to specify them here in order for inference to work
correctly for special forms like `Literal` or `Annotated`.

If you use relative imports for the compatibility module in your code-base
you will need to add separate entries for each kind of relative import you
use.

- **setting name**: `type-checking-typing-modules`
- **type**: `list`

```ini
[flake8]
type-checking-typing-modules = mylib.compat, .compat, ..compat # default []
```

### Exempt modules

If you wish to exempt certain modules from
Expand Down

0 comments on commit 76d4b9c

Please sign in to comment.