Skip to content

Commit 8fc65ae

Browse files
committed
Update README.rst
1 parent 902ba85 commit 8fc65ae

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.rst

+11-5
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,7 @@
22
jupyter-ui-poll
33
===============
44

5-
.. image:: https://mybinder.org/badge_logo.svg
6-
:target: `run it`_
5+
|Documentation Status| |Binder|
76

87
Block Jupyter cell execution while interacting with widgets.
98

@@ -59,7 +58,7 @@ Quick, self contained example:
5958
# Wait for user to press the button
6059
with ui_events() as poll:
6160
while ui_done is False:
62-
poll(10) # React to UI events (upto 10 at a time)
61+
poll(10) # React to UI events (up to 10 at a time)
6362
print('.', end='')
6463
time.sleep(0.1)
6564
print('done')
@@ -76,7 +75,7 @@ This library requires Python 3.6 or greater.
7675
7776
pip install jupyter-ui-poll
7877
# or with conda/mamba
79-
conda install -c kirill-odc jupyter-ui-poll
78+
conda install -c conda-forge jupyter-ui-poll
8079
8180
8281
Technical Details
@@ -87,7 +86,7 @@ interactive data investigation apps directly inside Jupyter notebook or Jupyter
8786
lab environment. Jupyter is great at displaying data and ``ipywidgets`` provide
8887
a mechanism to get input from the user in a more convenient way than entering or
8988
changing Python code inside a Jupyter cell. Developer can construct an
90-
interactive user interface often used to parameterise information display or
89+
interactive user interface often used to parameterize information display or
9190
other kinds of computation.
9291

9392
Interactivity is handled with callbacks, ``ipywidget`` GUI is HTML based, user
@@ -147,3 +146,10 @@ Basic idea was copied from ``ipython_blocking`` [#]_ project:
147146
.. _Example notebook: notebooks/Examples.ipynb
148147
.. _run it: https://mybinder.org/v2/gh/kirill888/jupyter-ui-poll/develop?filepath=notebooks%2FExamples.ipynb
149148
.. _Binder: https://mybinder.org/
149+
150+
.. |Documentation Status| image:: https://readthedocs.org/projects/jupyter-ui-poll/badge/?version=latest
151+
:target: https://jupyter-ui-poll.readthedocs.io/en/latest/?badge=latest
152+
153+
.. |Binder| image:: https://mybinder.org/badge_logo.svg
154+
:target: https://mybinder.org/v2/gh/kirill888/jupyter-ui-poll/develop?filepath=notebooks%2FExamples.ipynb
155+
:alt: Run Examples in Binder

0 commit comments

Comments
 (0)