Skip to content

gh-159308: Improve the documentation of the Tk option data types in Tkinter - #159309

Merged
serhiy-storchaka merged 2 commits into
python:mainfrom
serhiy-storchaka:tkinter-docs-option-data-types
Oct 16, 2026
Merged

serhiy-storchaka merged 2 commits into
python:mainfrom
serhiy-storchaka:tkinter-docs-option-data-types

Conversation

@serhiy-storchaka

@serhiy-storchaka serhiy-storchaka commented Oct 13, 2026 •

Copy link
Copy Markdown
Member

Fix inaccurate descriptions of the color, wrap, boolean, bitmap, callback, font, region and anchor types, and remove the obsolete geometry type: there is no such widget option.

Add the compound, orient, padding and state types.

Fix also several minor errors in the reference: getboolean() raises ValueError, not TclError, the Text widget can also scroll by pixels, the position returned by winfo_geometry() is relative to the parent widget, and the underline option of canvas text items was added in Tk 8.5, not in Tk 9.0.

…s in Tkinter

Fix inaccurate descriptions of the color, wrap, boolean, bitmap,
callback, font, region and anchor types, and remove the obsolete
"geometry" type: there is no such widget option.

Add the compound, orient, padding and state types.

Fix also several minor errors in the reference.
@read-the-docs-community

read-the-docs-community Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #35125022 | 📁 Comparing baeed7b against main (50082b8)

  🔍 Preview build  

5 files changed · ± 5 modified

± Modified

@terryjreedy terryjreedy left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I reviewed the English for clarity, not the option list for accuracy.

Comment thread Doc/library/tkinter.rst Outdated
@bedevere-app

bedevere-app Bot commented Oct 13, 2026

Copy link
Copy Markdown

When you're done making the requested changes, leave the comment: I have made the requested changes; please review again.

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
@terryjreedy
terryjreedy dismissed their stale review October 13, 2026 21:33

Requested change done.

@serhiy-storchaka
serhiy-storchaka merged commit 15f3d7f into python:main Oct 16, 2026
34 of 35 checks passed
@miss-islington-app

Copy link
Copy Markdown

Thanks @serhiy-storchaka for the PR 🌮🎉.. I'm working now to backport this PR to: 3.14, 3.15.
🐍🍒⛏🤖 I'm not a witch! I'm not a witch!

@github-project-automation github-project-automation Bot moved this from Todo to Done in Docs PRs Oct 16, 2026
@serhiy-storchaka
serhiy-storchaka deleted the tkinter-docs-option-data-types branch October 16, 2026 15:17
@bedevere-app

bedevere-app Bot commented Oct 16, 2026

Copy link
Copy Markdown

GH-159544 is a backport of this pull request to the 3.15 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 bugs and security fixes label Oct 16, 2026
@bedevere-app

bedevere-app Bot commented Oct 16, 2026

Copy link
Copy Markdown

GH-159545 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Oct 16, 2026
serhiy-storchaka added a commit that referenced this pull request Oct 16, 2026
…es in Tkinter (GH-159309) (GH-159544)

Fix inaccurate descriptions of the color, wrap, boolean, bitmap,
callback, font, region and anchor types, and remove the obsolete
"geometry" type: there is no such widget option.

Add the compound, orient, padding and state types.

Fix also several minor errors in the reference.
(cherry picked from commit 15f3d7f)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
serhiy-storchaka added a commit that referenced this pull request Oct 16, 2026
…es in Tkinter (GH-159309) (GH-159545)

Fix inaccurate descriptions of the color, wrap, boolean, bitmap,
callback, font, region and anchor types, and remove the obsolete
"geometry" type: there is no such widget option.

Add the compound, orient, padding and state types.

Fix also several minor errors in the reference.
(cherry picked from commit 15f3d7f)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip news

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants