Skip to content

Commit fcac543

Browse files
committed
Ready for 0.1.0 release
1 parent 2125cc0 commit fcac543

File tree

4 files changed

+31
-0
lines changed

4 files changed

+31
-0
lines changed

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,20 @@ Monads for `python` made simple and safe.
1414
- No operator overloading or other unpythonic stuff that makes your eyes bleed
1515

1616

17+
## What's inside?
18+
19+
We have several the most iconic monads inside:
20+
21+
- [`Result`, `Failure`, and `Success`](https://dry-monads.readthedocs.io/en/latest/pages/either.html) (also known as `Either`, `Left`, and `Right`)
22+
- `Maybe`, `Some`, and `Nothing` (currently WIP)
23+
- `Just` (currently WIP)
24+
25+
We also care about code readability and developer experience,
26+
so we have included some useful features to make your life easier:
27+
28+
- [Do notation](https://dry-monads.readthedocs.io/en/latest/pages/do-notation.html)
29+
30+
1731
## Inspirations
1832

1933
This module is heavily based on:

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ Contents
77
:maxdepth: 2
88
:caption: Userguide
99

10+
pages/monad.rst
1011
pages/either.rst
1112
pages/do-notation.rst
1213

docs/pages/do-notation.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,12 @@ and then return a simple ``Failure`` monad.
120120
user creation-->>pipeline: returns Failure(http status) if fails
121121
user creation-->>pipeline: returns Success(user) if user is created
122122

123+
See, do notation allows you to write simple yet powerful pipelines
124+
with multiple and complex steps.
125+
And at the same time the produced code is simple and readable.
126+
127+
And that's it!
128+
123129
API Reference
124130
-------------
125131

docs/pages/monad.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
Monad: the concept
2+
==================
3+
4+
API Reference
5+
-------------
6+
7+
.. autoclasstree:: dry_monads.primitives.monad
8+
9+
.. automodule:: dry_monads.primitives.monad
10+
:members:

0 commit comments

Comments
 (0)