gh-137777: Fix remove Program Frameworks chapter and relocate its modules#137796
gh-137777: Fix remove Program Frameworks chapter and relocate its modules#137796AA-Turner merged 5 commits intopython:mainfrom
Conversation
- 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
|
I think the document path is wrong. Let me check :( |
corona10
left a comment
There was a problem hiding this comment.
LGTM
I checked that the preview page is well rendered too :)
https://cpython-previews--137796.org.readthedocs.build/en/137796/library/frameworks.html
|
Let's wait @AA-Turner and @hugovk for the English feedback. |
hugovk
left a comment
There was a problem hiding this comment.
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
cmdis okay at the end; the others look more important to me. -
I was going to suggest putting
shlexsecond, afterposix; butposixbegins with a warning: "Do not import this module directly". So maybe putshlexfirst? -
turtleis important for education, but perhaps not if you're specifically reading the "Graphical user interfaces with Tk" chapter, and last position is fine?
There was a problem hiding this comment.
Let's update this file's header to sentence case:
-Graphical User Interfaces with Tk
+Graphical user interfaces with Tk
Thanks for the guidance! |
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. |
hugovk
left a comment
There was a problem hiding this comment.
Thanks, looks good!
I'll leave this open for a bit in case Adam wants to check it.
This also makes it easier to decide/debate what order to put things in :) Looks okay to do this for We'd have to take care with "Graphical User Interfaces with Tk", would it make sense to start with the current And they render like this, according to titles not filenames, where
Yeah, probably better to discuss separately from this one. |
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 |
|
Thanks @rimi0108 for the PR, and @AA-Turner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14. |
|
GH-137830 is a backport of this pull request to the 3.14 branch. |
|
GH-137831 is a backport of this pull request to the 3.13 branch. |
…honGH-137796) (python#137830) pythongh-137777: Disband the 'Program Frameworks' chapter (pythonGH-137796) (cherry picked from commit eee6589) Co-authored-by: rimchoi <hyerimc858@gmail.com>
📚 Documentation preview 📚: https://cpython-previews--137796.org.readthedocs.build/