gh-78335: Improve tkinter widget docstrings #21118
Conversation
Co-Authored-By: Noah Haasis <haasis_noah@yahoo.de>
|
This PR addresses the issues that were found in the old PR. |
There was a problem hiding this comment.
I checked the lists against https://www.tcl.tk/man/tcl8.6/TkCmd/contents.htm. I assumed 'bg' and 'fg' are valid even when not listed there.
Serhiy, do you want to separately review, or should I merge after corrections.
| fg, font, foreground, highlightbackground, highlightcolor, | ||
| highlightthickness, insertbackground, insertborderwidth, | ||
| insertofftime, insertontime, insertwidth, invalidcommand, | ||
| invcmd, justify, readonlybackground, relief, selectbackground, |
There was a problem hiding this comment.
The tk docs do not list 'invcmd' but do list 'vcmd'. So I will presume without conrary evidence that this is either missing from the tk doc or is added by tkinter.
There was a problem hiding this comment.
invcmd is an alias of invalidcommand and vcmd is an alias of validatecommand.
| @@ -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, | |||
There was a problem hiding this comment.
tk docs include bg, even though they do not for many of widgets above.
| background, bitmap, borderwidth, compound, | |
| background, bg, bitmap, borderwidth, compound, |
| insertborderwidth, insertofftime, | ||
| insertontime, insertwidth, padx, pady, | ||
| relief, selectbackground, | ||
| background, blockcursor, borderwidth, |
There was a problem hiding this comment.
The list of standard options was correct. The 6 additions
blockcursor, endline (spelled correctly), inactiveselectbackground, insertunfocused, startline, tabstyle,
should be moved to WIDGET-SPECIFIC OPTIONS
| @@ -4365,13 +4369,14 @@ def __init__(self, master=None, cnf={}, **kw): | |||
| STANDARD OPTIONS | |||
|
|
|||
| background, borderwidth, cursor, height, | |||
| orient, relief, width | |||
| orient, proxybackground, proxyborderwidth, | |||
There was a problem hiding this comment.
height and width were misplaced as standard. They and the 3 new proxy... options should be moved down.
|
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
Co-Authored-By: Noah Haasis haasis_noah@yahoo.de
https://bugs.python.org/issue34154