update README.rst

Signed-off-by: Stephen L. <lrq3000@gmail.com>
This commit is contained in:
Stephen L 2015-12-01 21:11:07 +01:00
parent e1f3eb9c36
commit 7197da11b3
1 changed files with 19 additions and 0 deletions

View File

@ -36,6 +36,9 @@ version is much more visually appealing.
``tqdm`` works on any platform (Linux/Windows/Mac), in any console or in a
GUI, and is also friendly with IPython/Jupyter notebooks.
``tqdm`` does not require any library nor curses to run, just a Python
interpreter.
Installation
------------
@ -277,6 +280,22 @@ In case you're interested in how this works (and how to modify it for your
own callbacks), see the `examples <https://github.com/tqdm/tqdm/tree/master/examples>`__
folder or import the module and run ``help()``.
Nested progress bars
~~~~~~~~~~~~~~~~~~~~
``tqdm`` supports nested progress bars, you just need to specify the
`nested=True` argument for all tqdm instanciation except the most outer bar.
Here's an example:
.. code:: python
from tqdm import trange
from time import sleep
for i in trange(10, desc='1st loop', leave=True):
for j in trange(100, desc='2nd loop', nested=True):
sleep(0.01)
Contributions
-------------