From 041e5a75d49a2b0331679890ee26074bcf9ae61d Mon Sep 17 00:00:00 2001 From: Richard Sheridan Date: Tue, 21 Jul 2020 07:39:03 -0400 Subject: [PATCH] document additional params --- tqdm/gui.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/tqdm/gui.py b/tqdm/gui.py index e2acf7df2..9f4814af1 100644 --- a/tqdm/gui.py +++ b/tqdm/gui.py @@ -328,6 +328,20 @@ class tqdm_tk(std_tqdm): # pragma: no cover """ def __init__(self, *args, **kwargs): + """ + This class accepts the following parameters *in addition* to + the parameters accepted by tqdm. + + Parameters + ---------- + grab : bool, optional + Grab the input across all windows of the process. + tk_parent : tkinter.Wm, optional + Parent Tk window. + cancel_callback : Callable, optional + Create a cancel button and set cancel_callback to be called + when the cancel or window close button is clicked. + """ try: grab = kwargs.pop("grab") except KeyError: