Skip to content

gh-137777: Fix remove Program Frameworks chapter and relocate its modules #137796

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

Merged
merged 5 commits into from
Aug 15, 2025

Conversation

rimi0108
Copy link
Contributor

@rimi0108 rimi0108 commented Aug 15, 2025

- Moved turtle docs under "Graphical User Interfaces with Tk"
- Moved cmd docs under "Command Line Interface Libraries"
- Moved shlex docs under "Unix Specific Services"
- Removed Program Frameworks from the library TOC
- Added orphan page at library/frameworks.rst with links to new locations
  to avoid 404s for existing inbound links
@rimi0108
Copy link
Contributor Author

@corona10

@rimi0108
Copy link
Contributor Author

I think the document path is wrong. Let me check :(

Copy link
Member

@corona10 corona10 left a comment

Choose a reason for hiding this comment

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

LGTM

I checked that the preview page is well rendered too :)

https://cpython-previews--137796.org.readthedocs.build/en/137796/library/frameworks.html

@corona10
Copy link
Member

Let's wait @AA-Turner and @hugovk for the English feedback.

Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!

I'm thinking about where to put the modules in their new locations. Should the be added to the end of the list, or put somewhere more prominent further up the list.

I don't have a strong position on the following, it's kind of based on my use of the libraries, which is far from objective :)

  • I think cmd is okay at the end; the others look more important to me.

  • I was going to suggest putting shlex second, after posix; but posix begins with a warning: "Do not import this module directly". So maybe put shlex first?

  • turtle is important for education, but perhaps not if you're specifically reading the "Graphical user interfaces with Tk" chapter, and last position is fine?

Copy link
Member

Choose a reason for hiding this comment

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

Let's update this file's header to sentence case:

-Graphical User Interfaces with Tk
+Graphical user interfaces with Tk

@rimi0108
Copy link
Contributor Author

rimi0108 commented Aug 15, 2025

Thanks for the PR!

I'm thinking about where to put the modules in their new locations. Should the be added to the end of the list, or put somewhere more prominent further up the list.

I don't have a strong position on the following, it's kind of based on my use of the libraries, which is far from objective :)

  • I think cmd is okay at the end; the others look more important to me.
  • I was going to suggest putting shlex second, after posix; but posix begins with a warning: "Do not import this module directly". So maybe put shlex first?
  • turtle is important for education, but perhaps not if you're specifically reading the "Graphical user interfaces with Tk" chapter, and last position is fine?

Thanks for the guidance!
Based on your suggestions, I’ll place shlex at the top, keep posix right after it (since it starts with a “do not import directly” warning), move cmd to the end, and keep turtle last within the Tk GUI chapter context.

@adorilson
Copy link
Contributor

adorilson commented Aug 15, 2025

I'm thinking about where to put the modules in their new locations. Should the be added to the end of the list, or put somewhere more prominent further up the list.

I don't have a strong position on the following, it's kind of based on my use of the libraries, which is far from objective :)

I have a strong and objective position here: alphabetical order. :)

It makes it easier for everyone to locate a module, but mainly for blind users of screen readers.

Edit: another issue/PR could make this change for every chapter listing modules.

Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Thanks, looks good!

I'll leave this open for a bit in case Adam wants to check it.

@hugovk hugovk added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Aug 15, 2025
@hugovk
Copy link
Member

hugovk commented Aug 15, 2025

I have a strong and objective position here: alphabetical order. :)

It makes it easier for everyone to locate a module, but mainly for blind users of screen readers.

This also makes it easier to decide/debate what order to put things in :)

Looks okay to do this for cmdlinelibs.rst and unix.rst.

We'd have to take care with "Graphical User Interfaces with Tk", would it make sense to start with the current tkinter.rst intro page?

   tkinter.rst
   tkinter.colorchooser.rst
   tkinter.font.rst
   dialog.rst
   tkinter.messagebox.rst
   tkinter.scrolledtext.rst
   tkinter.dnd.rst
   tkinter.ttk.rst
   idle.rst
   turtle.rst

And they render like this, according to titles not filenames, where dialog.rst is "Tkinter Dialogs" and shouldn't be first:

  • Graphical User Interfaces with Tk
    • tkinter — Python interface to Tcl/Tk
    • tkinter.colorchooser — Color choosing dialog
    • tkinter.font — Tkinter font wrapper
    • Tkinter Dialogs
    • tkinter.messagebox — Tkinter message prompts
    • tkinter.scrolledtext — Scrolled Text Widget
    • tkinter.dnd — Drag and drop support
    • tkinter.ttk — Tk themed widgets
    • IDLE — Python editor and shell

Edit: another issue/PR could make this change for every chapter listing modules.

Yeah, probably better to discuss separately from this one.

@adorilson
Copy link
Contributor

And they render like this, according to titles not filenames, where dialog.rst is "Tkinter Dialogs" and shouldn't be first:

Yeah. The order must be according to the title (what the reader sees), not filenames.

The problem here is that "Tkinter Dialogs" is not a module itself, but something like a sub-chapter (why isn't tkinter.colorchooser — Color choosing dialog here ?).

I think "Graphical User Interfaces with Tk" deserves its discussion. I've touched on this in the initial post.

For now, "Tkinter Dialogs" could come after tkinter.* stuffs. Currently, it looks like an alien. :)

@AA-Turner AA-Turner merged commit eee6589 into python:main Aug 15, 2025
31 checks passed
@miss-islington-app
Copy link

Thanks @rimi0108 for the PR, and @AA-Turner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Aug 15, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 15, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 15, 2025
@bedevere-app
Copy link

bedevere-app bot commented Aug 15, 2025

GH-137830 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 Aug 15, 2025
@bedevere-app
Copy link

bedevere-app bot commented Aug 15, 2025

GH-137831 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Aug 15, 2025
hugovk pushed a commit that referenced this pull request Aug 16, 2025
#137830)

gh-137777: Disband the 'Program Frameworks' chapter (GH-137796)
(cherry picked from commit eee6589)

Co-authored-by: rimchoi <[email protected]>
Agent-Hellboy pushed a commit to Agent-Hellboy/cpython that referenced this pull request Aug 19, 2025
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 sprint
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

6 participants