From d0a34e278ddeaa7715f0edafde7cc85cd168ae0f Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Sun, 10 Jan 2021 23:31:12 +0000 Subject: [PATCH] minor docstring fixes --- tqdm/gui.py | 3 +-- tqdm/tk.py | 7 +++---- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/tqdm/gui.py b/tqdm/gui.py index ac5b621c..1daab1ef 100644 --- a/tqdm/gui.py +++ b/tqdm/gui.py @@ -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 diff --git a/tqdm/tk.py b/tqdm/tk.py index 57048a52..92adb51d 100644 --- a/tqdm/tk.py +++ b/tqdm/tk.py @@ -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)