Skip to content

Commit

Permalink
Add version note + update some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dbrattli committed Mar 6, 2022
1 parent c5a7259 commit a295afa
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
12 changes: 6 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,11 @@ install:
About ReactiveX
---------------

ReactiveX for Python (RxPY) is a set of libraries for composing asynchronous and
event-based programs using observable sequences and pipable query operators in Python.
Using Rx, developers represent asynchronous data streams with Observables, query
asynchronous data streams using operators, and parameterize concurrency in data/event
streams using Schedulers.
ReactiveX for Python (RxPY) is a library for composing asynchronous and event-based
programs using observable sequences and pipable query operators in Python. Using Rx,
developers represent asynchronous data streams with Observables, query asynchronous data
streams using operators, and parameterize concurrency in data/event streams using
Schedulers.

.. code:: python
Expand All @@ -67,7 +67,7 @@ Read the `documentation
the principles of ReactiveX and get the complete reference of the available
operators.

If you need to migrate code from RxPY v1.x, read the `migration
If you need to migrate code from RxPY v1.x or v3.x, read the `migration
<https://rxpy.readthedocs.io/en/latest/migration.html>`_ section.

There is also a list of third party documentation available `here
Expand Down
4 changes: 2 additions & 2 deletions docs/migration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ current Python standards:

.. code:: python
import reactivex
import reactivex as rx
from reactivex import operators as ops
reactivex.of("Alpha", "Beta", "Gamma", "Delta", "Epsilon").pipe(
rx.of("Alpha", "Beta", "Gamma", "Delta", "Epsilon").pipe(
ops.map(lambda s: len(s)),
ops.filter(lambda i: i >= 5)
).subscribe(lambda value: print("Received {0}".format(value)))
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "ReactiveX"
version = "0.0.0"
version = "0.0.0" # NOTE: will be updated by publish script
description = "ReactiveX (Rx) for Python"
readme = "README.rst"
authors = ["Dag Brattli <dag@brattli.net>"]
Expand Down

0 comments on commit a295afa

Please sign in to comment.