gh-86726: Improve the structure of the tkinter reference#152109
Merged
serhiy-storchaka merged 1 commit intoJun 24, 2026
Conversation
Add short group intros before each cluster of Misc methods. Group the Tk and Toplevel classes in a new "Toplevel widgets" section, move the Tcl() function to the module-level functions, and move the "File handlers" section into the reference. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Documentation build overview
|
|
Thanks @serhiy-storchaka for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14, 3.15. |
|
Sorry, @serhiy-storchaka, I could not cleanly backport this to |
|
Sorry, @serhiy-storchaka, I could not cleanly backport this to |
|
Sorry, @serhiy-storchaka, I could not cleanly backport this to |
serhiy-storchaka
added a commit
that referenced
this pull request
Jun 24, 2026
…52109 (GH-152111) Add short group intros before each cluster of Misc methods. Group the Tk and Toplevel classes in a new "Toplevel widgets" section, move the Tcl() function to the module-level functions, and move the "File handlers" section into the reference. (cherry picked from commit c7faa69) Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Several structural improvements to the
tkintermodule reference, all documentation-only.Add short group intros before each cluster of
Miscmethods (thebind,event_,after,focus_,grab_,selection_,clipboard_,option_,busy_andwinfo_prefixes), so each run of related methods is introduced by a sentence explaining what the prefix means.Group the
TkandToplevelclasses in a new "Toplevel widgets" section, instead of documentingTkin the middle of the "Tkinter modules" overview and leavingTopleveldangling at the end of the base and mixin classes. Move theTcl()factory function to the module-level functions section, add a reference to it fromTk, and document thatTkinherits fromMiscandWm.Move the "File handlers" section into the reference, where its
createfilehandler/deletefilehandlermethods andREADABLE/WRITABLE/EXCEPTIONconstants belong, instead of leaving it as a standalone section just before the reference. The cross-reference target is preserved.