Skip to content

Commit

Permalink
small tweaks to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
adrn committed Aug 4, 2017
1 parent 25363c2 commit 5a6445a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
7 changes: 3 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,10 +68,9 @@ The easiest way to install is via `pip`::

pip install schwimmbad

The project is also installable by cloning or downloading the source and using
the standard::

python setup.py install
See the `installation
instructions <http://schwimmbad.readthedocs.io/en/latest/install.html>`_ in the
`documentation <http://schwimmbad.readthedocs.io>`_ for more information.

Documentation
-------------
Expand Down
8 changes: 6 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -79,12 +79,16 @@ we're now using a `context manager
<https://en.wikibooks.org/wiki/Python_Programming/Context_Managers>`_ (using a
Python ``with`` statement) to handle creating and *closing* the multiprocessing
pool. With the exception of the :class:`~schwimmbad.serial.SerialPool`, all
other pool classes need to be explicity closed after processing.
other pool classes need to be explicity closed after processing. We could have
also written::

pool = MultiPool()
values = list(pool.map(do_the_processing, data))
pool.close()

See the examples listed below for demonstrations of using the
:class:`~schwimmbad.mpi.MPIPool` and :class:`~schwimmbad.jl.JoblibPool`.


More examples / use cases
-------------------------

Expand Down

0 comments on commit 5a6445a

Please sign in to comment.