gh-78335: Improve tkinter widget docstrings by ZackerySpytz · Pull Request #21118

gh-78335: Improve tkinter widget docstrings by ZackerySpytz · Pull Request #21118 · python/cpython

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

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

Choose a reason for hiding this comment

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

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,

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.

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.

		activebackground, activeforeground, anchor,
		background, bitmap, borderwidth, cursor,
		disabledforeground, font, foreground,
		background, bitmap, borderwidth, compound,

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.

	background, bitmap, borderwidth, compound,
	background, bg, bitmap, borderwidth, compound,

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

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


		background, borderwidth, cursor, height,
		orient, relief, width
		orient, proxybackground, proxyborderwidth,

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.

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.

erlend-aasland changed the title ~~bpo-34154: Improve tkinter widget docstrings~~ gh-78335: Improve tkinter widget docstrings

Jan 5, 2024

This PR is stale because it has been open for 30 days with no activity.