Skip to content

Commit c8b0219

Browse files
authored
Update README.md
1 parent b11c288 commit c8b0219

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,13 @@ Make your functions return something meaningful, typed, and safe!
3636
pip install returns
3737
```
3838

39-
You are also required to [configure](https://returns.readthedocs.io/en/latest/pages/container.html#type-safety)
40-
`mypy` correctly and install our plugin
41-
to fix [this existing issue](https://github.com/python/mypy/issues/3157):
39+
You can also install `returns` with the latest supported `mypy` version:
4240

4341
```bash
4442
pip install returns[compatible-mypy]
4543
```
46-
and
44+
45+
You would also need to configure our [`mypy` plugin](https://returns.readthedocs.io/en/latest/pages/contrib/mypy_plugins.html):
4746

4847
```ini
4948
# In setup.cfg or mypy.ini:
@@ -52,6 +51,13 @@ plugins =
5251
returns.contrib.mypy.returns_plugin
5352
```
5453

54+
or:
55+
56+
```toml
57+
[tool.mypy]
58+
plugins = ["returns.contrib.mypy.returns_plugin"]
59+
```
60+
5561
We also recommend to use the same `mypy` settings [we use](https://github.com/wemake-services/wemake-python-styleguide/blob/master/styles/mypy.toml).
5662

5763
Make sure you know how to get started, [check out our docs](https://returns.readthedocs.io/en/latest/)!

0 commit comments

Comments
 (0)