NotificationsYou must be signed in to change notification settings
Fork32.1k
Star67.4k

gh-78335: Improve tkinter widget docstrings#21118

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Open

ZackerySpytz wants to merge2 commits intopython:main

base:main

Choose a base branch

fromZackerySpytz:bpo-34154-tkinter-widget-docstrings

Open

gh-78335: Improve tkinter widget docstrings#21118

ZackerySpytz wants to merge2 commits intopython:mainfromZackerySpytz:bpo-34154-tkinter-widget-docstrings

Conversation

Copy link

Contributor

ZackerySpytz commentedJun 24, 2020•
edited by bedevere-appbot
Loading

Co-Authored-By: Noah Haasishaasis_noah@yahoo.de

https://bugs.python.org/issue34154

Issue:Tkinter __init__ documentations sometimes missing valid keyword values #78335

bpo-34154: Improve tkinter widget docstrings

2a706a3

Co-Authored-By: Noah Haasis <haasis_noah@yahoo.de>

the-knights-who-say-ni added the CLA signed label

Jun 24, 2020

bedevere-bot added the awaiting review label

Jun 24, 2020

Copy link

ContributorAuthor

ZackerySpytz commentedJun 24, 2020

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

terryjreedy requested changes

Jun 25, 2020

View reviewed changes

Copy link

Member

terryjreedy left a comment

Choose a reason for hiding this comment

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

I checked the lists againsthttps://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.

Lib/tkinter/__init__.py

		fg, font, foreground, highlightbackground, highlightcolor,
		highlightthickness, insertbackground, insertborderwidth,
		insertofftime, insertontime, insertwidth, invalidcommand,
		invcmd, justify, readonlybackground, relief, selectbackground,

Copy link

Member

terryjreedyJun 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-storchakaJul 15, 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 ofinvalidcommand andvcmd is an alias ofvalidatecommand.

Lib/tkinter/__init__.py

		@@ -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

terryjreedyJun 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,

Lib/tkinter/__init__.py

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

Copy link

Member

terryjreedyJun 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

Lib/tkinter/__init__.py

		@@ -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

terryjreedyJun 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 removed the awaiting review label

Jun 25, 2020

Copy link

bedevere-bot commentedJun 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 phraseI 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.