Skip to content

Commit 76d4b9c

Browse files
committed
Adds a section to the README for the new setting
1 parent 1136e55 commit 76d4b9c

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -128,6 +128,24 @@ pip install flake8-type-checking
128128

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

131+
### Typing modules
132+
133+
If you re-export `typing` or `typing_extensions` members from a compatibility
134+
module, you will need to specify them here in order for inference to work
135+
correctly for special forms like `Literal` or `Annotated`.
136+
137+
If you use relative imports for the compatibility module in your code-base
138+
you will need to add separate entries for each kind of relative import you
139+
use.
140+
141+
- **setting name**: `type-checking-typing-modules`
142+
- **type**: `list`
143+
144+
```ini
145+
[flake8]
146+
type-checking-typing-modules = mylib.compat, .compat, ..compat # default []
147+
```
148+
131149
### Exempt modules
132150

133151
If you wish to exempt certain modules from

0 commit comments

Comments
 (0)