updated documentation

This commit is contained in:
Casper da Costa-Luis 2015-10-13 20:35:43 +01:00 committed by Casper da Costa-Luis
parent df0e6472ba
commit bb9bc486ea
3 changed files with 3 additions and 7 deletions

View File

@ -18,7 +18,7 @@ iterable with "tqdm(iterable)", and you're done!
Here's what the output looks like:
76%\|████████████████████\ ``_`` ``_`` ``_`` \| 7641/10000 [00:34<00:10,
76%\|████████████████████\             \| 7641/10000 [00:34<00:10,
222.22 it/s]
You can also use ``trange(N)`` as a shortcut for ``tqdm(xrange(N))``
@ -57,7 +57,7 @@ Documentation
.. code:: python
class tqdm:
class tqdm(object):
"""
Decorate an iterable object, returning an iterator which acts exactly
like the orignal iterable, but prints a dynamically updating
@ -98,7 +98,6 @@ Documentation
Minimum progress update interval, in seconds [default: 0.1].
miniters : int, optional
Minimum progress update interval, in iterations [default: None].
If specified, will set `mininterval` to 0.
ascii : bool, optional
If [default: None] or false, use unicode (▏▎▋█ █) to fill
the meter. The fallback is to use ASCII characters `1-9 #`.

View File

@ -193,7 +193,6 @@ class tqdm(object):
like the orignal iterable, but prints a dynamically updating
progressbar every time a value is requested.
"""
def __init__(self, iterable=None, desc=None, total=None, leave=False,
file=sys.stderr, ncols=None, mininterval=0.1,
miniters=None, ascii=None, disable=False,
@ -229,7 +228,6 @@ class tqdm(object):
Minimum progress update interval, in seconds [default: 0.1].
miniters : int, optional
Minimum progress update interval, in iterations [default: None].
If specified, will set `mininterval` to 0.
ascii : bool, optional
If [default: None] or false, use unicode (smooth blocks) to fill
the meter. The fallback is to use ASCII characters `1-9 #`.

View File

@ -188,8 +188,7 @@ def test_dynamic_min_iters():
assert "70%" in out
our_file = StringIO()
t = tqdm(range(10), file=our_file, miniters=None, mininterval=None,
leave=True)
t = tqdm(range(10), file=our_file, miniters=None, mininterval=None)
for i in t:
pass
assert t.dynamic_miniters