minor docstring fixes

This commit is contained in:
Casper da Costa-Luis 2021-01-10 23:31:12 +00:00
parent f2be444e25
commit d0a34e278d
No known key found for this signature in database
GPG Key ID: 986B408043AE090D
2 changed files with 4 additions and 6 deletions

View File

@ -1,6 +1,5 @@
"""
GUI progressbar decorator for iterators.
Includes a default `range` iterator printing to `stderr`.
Matplotlib GUI progressbar decorator for iterators.
Usage:
>>> from tqdm.gui import trange, tqdm

View File

@ -1,9 +1,8 @@
"""
GUI progressbar decorator for iterators.
Includes a default `range` iterator printing to `stderr`.
Tkinter GUI progressbar decorator for iterators.
Usage:
>>> from tqdm.gui import trange, tqdm
>>> from tqdm.tk import trange, tqdm
>>> for i in trange(10):
... ...
"""
@ -197,7 +196,7 @@ class tqdm_tk(std_tqdm): # pragma: no cover
def ttkrange(*args, **kwargs):
"""
A shortcut for `tqdm.gui.tqdm_tk(xrange(*args), **kwargs)`.
A shortcut for `tqdm.tk.tqdm(xrange(*args), **kwargs)`.
On Python3+, `range` is used instead of `xrange`.
"""
return tqdm_tk(_range(*args), **kwargs)