Skip to content

Commit c43f9c1

Browse files
committed
various documentation/README cleanups
1 parent 81a5d1a commit c43f9c1

2 files changed

Lines changed: 20 additions & 20 deletions

File tree

README.rst

Lines changed: 13 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,41 +4,35 @@ Effect
44
.. image:: https://travis-ci.org/python-effect/effect.svg?branch=master
55
:target: https://travis-ci.org/python-effect/effect
66

7-
Effect is a library for helping you write purely functional code by
8-
isolating the effects (that is, IO or state manipulation) in your code.
9-
Documentation is available at https://effect.readthedocs.org/.
10-
11-
.. image:: https://radix.github.io/effect/sigh-defects.png
12-
:target: https://twitter.com/extempore2/status/553597279463305218
7+
Effect is a library for helping you write purely functional code by isolating
8+
the effects (that is, IO or state manipulation) in your code. Documentation is
9+
available at https://effect.readthedocs.org/, and its PyPI page is
10+
https://pypi.python.org/pypi/effect.
1311

12+
It `supports`_ both Python 2.6 and up, and 3.4 and up, as well as PyPy.
1413

14+
.. _`supports`: https://travis-ci.org/python-effect/effect
1515

16-
Status: Alpha
17-
=============
16+
You can install it by running ``pip install effect``.
1817

19-
Right now Effect is in alpha, and is likely to change incompatibly. Once it's
20-
being used in production and the API seems pretty good, a final version will be
21-
released. Because it's in alpha, ``pip`` requires that you explicitly specify
22-
the version number when specifying a dependency. This means that you won't
23-
automatically get upgraded to newer versions that potentially break the API.
24-
e.g., use `pip install effect==0.1aN`.
18+
.. image:: https://radix.github.io/effect/sigh-defects.png
19+
:target: https://twitter.com/extempore2/status/553597279463305218
2520

2621

2722
What Is It?
2823
===========
2924

30-
Effect lets you isolate your IO and state-manipulation code, by using a system
31-
very similar to Haskell's `extensible-effects`_ package. It also has
32-
similarities to Twisted's Deferred objects.
33-
34-
.. _`extensible-effects`: https://hackage.haskell.org/package/extensible-effects
25+
Effect lets you isolate your IO and state-manipulation code.
3526

3627
The benefits of this are many: first, the majority of your code can become
3728
purely functional, leading to easier testing and ability to reason about
3829
behavior. Also, because it separates the specification of an effect from the
3930
performance of the effect, there are two more benefits: testing becomes easier
4031
still, and it's easy to provide alternative implementations of effects.
4132

33+
Effect is somewhat similar to "algebraic effects", as implemented in various
34+
typed functional programming languages. It also has similarities to Twisted's
35+
Deferred objects.
4236

4337
Example
4438
=======

docs/source/index.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,15 @@
55
66
Effect
77
======
8+
89
Effect is a library for helping you write purely functional code by
910
isolating the effects (that is, IO or state manipulation) in your code.
1011

12+
It supports both Python 2.6 and up, and 3.4 and up, as well as PyPy.
13+
14+
It lives on PyPI at https://pypi.python.org/pypi/effect and GitHub at
15+
https://github.com/python-effect/effect.
16+
1117

1218
API
1319
===
@@ -30,7 +36,7 @@ performs side-effects (such as IO):
3036
.. code:: python
3137
3238
def get_user_name():
33-
return raw_input("Enter User Name> ")
39+
return raw_input("Enter User Name> ") # or 'input' in Python 3
3440
3541
you instead have a function which *returns* a representation of the
3642
side-effect:

0 commit comments

Comments
 (0)