Skip to content

Commit 92eda55

Browse files
committed
Improves docs
1 parent 8e8e93d commit 92eda55

File tree

4 files changed

+10
-2
lines changed

4 files changed

+10
-2
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ We follow Semantic Versions since the `0.1.0` release.
77

88
### Features
99

10+
- Adds `mypy` plugin to type decorators
1011
- Complete rewrite of `Result` types
1112
- Partial API change, now `Success` and `Failure` are not types, but functions
1213
- New internal types introduced: `FixableContainer` and `ValueUnwrapContainer`

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ If you want to start working on this project,
66
you will need to get familiar with these concepts:
77

88
- http://learnyouahaskell.com/functors-applicative-functors-and-monoids
9+
- https://github.com/dbrattli/OSlash/wiki/Functors,-Applicatives,-And-Monads-In-Pictures
910

1011
Here are some practical examples of what we are doing here:
1112

@@ -53,7 +54,7 @@ We use `mypy` to run type checks on our code.
5354
To use it:
5455

5556
```bash
56-
mypy returns
57+
mypy returns tests/**/*.py
5758
```
5859

5960
This step is mandatory during the CI.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ pip install returns
2727
You might also need to [configure](https://returns.readthedocs.io/en/latest/pages/container.html#type-safety)
2828
`mypy` correctly and install our plugin:
2929

30-
```cfg
30+
```ini
3131
[mypy]
3232
plugins =
3333
returns.contrib.mypy.decorator_plugin

docs/pages/container.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -273,6 +273,12 @@ since they increase your developer experience and type-safety:
273273

274274
- ``decorator_plugin`` to solve untyped `decorator issue <https://github.com/python/mypy/issues/3157>`_
275275

276+
.. code:: ini
277+
278+
[mypy]
279+
plugins =
280+
returns.contrib.mypy.decorator_plugin
281+
276282
You can have a look at the suggested ``mypy``
277283
`configuration <https://github.com/dry-python/returns/blob/master/setup.cfg>`_
278284
in our own repository.

0 commit comments

Comments
 (0)