From 2a706a35f0da3d5b7e9b5f382b50eddcfcb7f741 Mon Sep 17 00:00:00 2001 From: Zackery Spytz Date: Wed, 24 Jun 2020 08:45:06 -0600 Subject: [PATCH] bpo-34154: Improve tkinter widget docstrings Co-Authored-By: Noah Haasis --- Lib/tkinter/__init__.py | 85 ++++++++++--------- .../2020-06-24-08-44-06.bpo-34154.coStMk.rst | 1 + 2 files changed, 46 insertions(+), 40 deletions(-) create mode 100644 Misc/NEWS.d/next/Library/2020-06-24-08-44-06.bpo-34154.coStMk.rst diff --git a/Lib/tkinter/__init__.py b/Lib/tkinter/__init__.py index a3378d012fb41ab..bb55969f4129ba8 100644 --- a/Lib/tkinter/__init__.py +++ b/Lib/tkinter/__init__.py @@ -2600,8 +2600,8 @@ def __init__(self, master=None, cnf={}, **kw): Valid resource names: background, bd, bg, borderwidth, class, colormap, container, cursor, height, highlightbackground, - highlightcolor, highlightthickness, menu, relief, screen, takefocus, - use, visual, width.""" + highlightcolor, highlightthickness, menu, padx, pady, relief, + screen, takefocus, use, visual, width.""" if kw: cnf = _cnfmerge((cnf, kw)) extra = () @@ -2986,12 +2986,13 @@ def __init__(self, master=None, cnf={}, **kw): """Construct a checkbutton widget with the parent MASTER. Valid resource names: activebackground, activeforeground, anchor, - background, bd, bg, bitmap, borderwidth, command, cursor, + background, bd, bg, bitmap, borderwidth, command, compound, cursor, disabledforeground, fg, font, foreground, height, highlightbackground, highlightcolor, highlightthickness, image, - indicatoron, justify, offvalue, onvalue, padx, pady, relief, - selectcolor, selectimage, state, takefocus, text, textvariable, - underline, variable, width, wraplength.""" + indicatoron, justify, offrelief, offvalue, onvalue, overrelief, + padx, pady, relief, selectcolor, selectimage, state, takefocus, + text, textvariable, tristateimage, tristatevalue, underline, + variable, width, wraplength.""" Widget.__init__(self, master, 'checkbutton', cnf, kw) def deselect(self): @@ -3022,10 +3023,11 @@ def __init__(self, master=None, cnf={}, **kw): """Construct an entry widget with the parent MASTER. Valid resource names: background, bd, bg, borderwidth, cursor, - exportselection, fg, font, foreground, highlightbackground, - highlightcolor, highlightthickness, insertbackground, - insertborderwidth, insertofftime, insertontime, insertwidth, - invalidcommand, invcmd, justify, relief, selectbackground, + disabledbackground, disabledforeground, exportselection, + fg, font, foreground, highlightbackground, highlightcolor, + highlightthickness, insertbackground, insertborderwidth, + insertofftime, insertontime, insertwidth, invalidcommand, + invcmd, justify, readonlybackground, relief, selectbackground, selectborderwidth, selectforeground, show, state, takefocus, textvariable, validate, validatecommand, vcmd, width, xscrollcommand.""" @@ -3109,7 +3111,8 @@ def __init__(self, master=None, cnf={}, **kw): Valid resource names: background, bd, bg, borderwidth, class, colormap, container, cursor, height, highlightbackground, - highlightcolor, highlightthickness, relief, takefocus, visual, width.""" + highlightcolor, highlightthickness, padx, pady, relief, takefocus, + visual, width.""" cnf = _cnfmerge((cnf, kw)) extra = () if 'class_' in cnf: @@ -3130,8 +3133,8 @@ def __init__(self, master=None, cnf={}, **kw): STANDARD OPTIONS activebackground, activeforeground, anchor, - background, bitmap, borderwidth, cursor, - disabledforeground, font, foreground, + background, bitmap, borderwidth, compound, + cursor, disabledforeground, font, foreground, highlightbackground, highlightcolor, highlightthickness, image, justify, padx, pady, relief, takefocus, text, @@ -3151,11 +3154,12 @@ class Listbox(Widget, XView, YView): def __init__(self, master=None, cnf={}, **kw): """Construct a listbox widget with the parent MASTER. - Valid resource names: background, bd, bg, borderwidth, cursor, - exportselection, fg, font, foreground, height, highlightbackground, - highlightcolor, highlightthickness, relief, selectbackground, - selectborderwidth, selectforeground, selectmode, setgrid, takefocus, - width, xscrollcommand, yscrollcommand, listvariable.""" + Valid resource names: activestyle, background, bd, bg, borderwidth, + cursor, disabledforeground, exportselection, fg, font, foreground, + height, highlightbackground, highlightcolor, highlightthickness, + justify, listvariable, relief, selectbackground, selectborderwidth, + selectforeground, selectmode, setgrid, state, takefocus, width, + xscrollcommand, yscrollcommand.""" Widget.__init__(self, master, 'listbox', cnf, kw) def activate(self, index): @@ -3412,12 +3416,12 @@ def __init__(self, master=None, cnf={}, **kw): """Construct a radiobutton widget with the parent MASTER. Valid resource names: activebackground, activeforeground, anchor, - background, bd, bg, bitmap, borderwidth, command, cursor, - disabledforeground, fg, font, foreground, height, - highlightbackground, highlightcolor, highlightthickness, image, - indicatoron, justify, padx, pady, relief, selectcolor, selectimage, - state, takefocus, text, textvariable, underline, value, variable, - width, wraplength.""" + background, bd, bg, bitmap, borderwidth, command, compound, cursor, + disabledforeground, fg, font, foreground, height, highlightbackground, + highlightcolor, highlightthickness, image, indicatoron, justify, + offrelief, overrelief, padx, pady, relief, selectcolor, selectimage, + state, takefocus, text, textvariable, tristateimage, tristatevalue, + underline, value, variable, width, wraplength.""" Widget.__init__(self, master, 'radiobutton', cnf, kw) def deselect(self): @@ -3535,22 +3539,22 @@ def __init__(self, master=None, cnf={}, **kw): STANDARD OPTIONS - background, borderwidth, cursor, - exportselection, font, foreground, - highlightbackground, highlightcolor, - highlightthickness, insertbackground, - insertborderwidth, insertofftime, - insertontime, insertwidth, padx, pady, - relief, selectbackground, + background, blockcursor, borderwidth, + cursor, endine, exportselection, font, + foreground, highlightbackground, highlightcolor, + highlightthickness, inactiveselectbackground, + insertbackground, insertborderwidth, + insertofftime, insertontime, insertunfocused, + insertwidth, padx, pady, relief, selectbackground, selectborderwidth, selectforeground, - setgrid, takefocus, - xscrollcommand, yscrollcommand, + setgrid, startline, tabstyle, takefocus, + xscrollcommand, yscrollcommand. WIDGET-SPECIFIC OPTIONS autoseparators, height, maxundo, spacing1, spacing2, spacing3, - state, tabs, undo, width, wrap, + state, tabs, undo, width, wrap. """ Widget.__init__(self, master, 'text', cnf, kw) @@ -4169,8 +4173,8 @@ def __init__(self, master=None, cnf={}, **kw): insertborderwidth, insertofftime, insertontime, insertwidth, justify, relief, repeatdelay, repeatinterval, - selectbackground, selectborderwidth - selectforeground, takefocus, textvariable + selectbackground, selectborderwidth, + selectforeground, takefocus, textvariable, xscrollcommand. WIDGET-SPECIFIC OPTIONS @@ -4181,8 +4185,8 @@ def __init__(self, master=None, cnf={}, **kw): disabledforeground, format, from, invalidcommand, increment, readonlybackground, state, to, - validate, validatecommand values, - width, wrap, + validate, validatecommand, values, + width, wrap. """ Widget.__init__(self, master, 'spinbox', cnf, kw) @@ -4365,13 +4369,14 @@ def __init__(self, master=None, cnf={}, **kw): STANDARD OPTIONS background, borderwidth, cursor, height, - orient, relief, width + orient, proxybackground, proxyborderwidth, + proxyrelief, relief, width. WIDGET-SPECIFIC OPTIONS handlepad, handlesize, opaqueresize, sashcursor, sashpad, sashrelief, - sashwidth, showhandle, + sashwidth, showhandle. """ Widget.__init__(self, master, 'panedwindow', cnf, kw) diff --git a/Misc/NEWS.d/next/Library/2020-06-24-08-44-06.bpo-34154.coStMk.rst b/Misc/NEWS.d/next/Library/2020-06-24-08-44-06.bpo-34154.coStMk.rst new file mode 100644 index 000000000000000..1c44a1e0a05797a --- /dev/null +++ b/Misc/NEWS.d/next/Library/2020-06-24-08-44-06.bpo-34154.coStMk.rst @@ -0,0 +1 @@ +Improve the docstrings in the :mod:`tkinter` module.