Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bpo-34154: Improve tkinter widget docstrings #21118

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ZackerySpytz
Copy link
Contributor

@ZackerySpytz ZackerySpytz commented Jun 24, 2020

Co-Authored-By: Noah Haasis <haasis_noah@yahoo.de>
@ZackerySpytz
Copy link
Contributor Author

ZackerySpytz commented Jun 24, 2020

This PR addresses the issues that were found in the old PR.

Copy link
Member

@terryjreedy terryjreedy left a 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,
Copy link
Member

@terryjreedy terryjreedy Jun 25, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Member

@serhiy-storchaka serhiy-storchaka Dec 25, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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,
Copy link
Member

@terryjreedy terryjreedy Jun 25, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tk docs include bg, even though they do not for many of widgets above.

Suggested change
background, bitmap, borderwidth, compound,
background, bg, bitmap, borderwidth, compound,

insertborderwidth, insertofftime,
insertontime, insertwidth, padx, pady,
relief, selectbackground,
background, blockcursor, borderwidth,
Copy link
Member

@terryjreedy terryjreedy Jun 25, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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,
Copy link
Member

@terryjreedy terryjreedy Jun 25, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

height and width were misplaced as standard. They and the 3 new proxy... options should be moved down.

@bedevere-bot
Copy link

bedevere-bot commented Jun 25, 2020

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 I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants