gh-129699: Add description to IDLE doc title #129727
Conversation
|
Updating the test to the new title. This test over all should be improved as this is not very sustainable. Found error in help.py, and updated it. |
|
Fix works (Ubuntu fails are a bug in GitHubs containers see #129664 ) |
|
@StanFromIreland Thank you for fixing the bug. I found it but was too sleepy to try a fix. Rerunning the Ubuntu test(s) worked. @encukou Could you do a quick 2nd coredev review? The main thing to look at would be the 2 new descriptions. idle.html is generated. The test fix is to add the new description to the expected first line of the tkinter text widget filled by parsing help.html (modified from idle.html). The test worked to not only detect the change, but show that the new 'actual' was not what it should have been: 'IDLE' was deleted. This was due to a bug in the tag content extraction logic in help.HelpParser.handle_data. I manually checked Stan's fix on my system, and there is only the one |
There was a problem hiding this comment.
IDLE's docs window looks as it should on Linux, Mac, Windows.
I don't claim to understand the details of what help.py does, but I don't see anything wrong with it.
(If it was new code I'd recommend removeprefix.)
|
Thank you for the comment. I did not write the decade-old HelpParser methods and I don't remember why the |
|
Thanks @StanFromIreland for the PR, and @terryjreedy for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13. |
Also extend the 'idlelib' section header. These additions affect both the displayed idle.html file and the contents.html file displayed by clicking the Complete table of contents link on the main docs.python.org page. (The module index entries are generated from the module name and synopsis within module files.) --------- (cherry picked from commit 33a7094) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
|
GH-129864 is a backport of this pull request to the 3.13 branch. |
Also extend the 'idlelib' section header. These additions affect both the displayed idle.html file and the contents.html file displayed by clicking the Complete table of contents link on the main docs.python.org page. (The module index entries are generated from the module name and synopsis within module files.) --------- (cherry picked from commit 33a7094) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
|
GH-129865 is a backport of this pull request to the 3.12 branch. |
) gh-129699: Add description to IDLE doc title (GH-129727) Also extend the 'idlelib' section header. These additions affect both the displayed idle.html file and the contents.html file displayed by clicking the Complete table of contents link on the main docs.python.org page. (The module index entries are generated from the module name and synopsis within module files.) --------- (cherry picked from commit 33a7094) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
) gh-129699: Add description to IDLE doc title (GH-129727) Also extend the 'idlelib' section header. These additions affect both the displayed idle.html file and the contents.html file displayed by clicking the Complete table of contents link on the main docs.python.org page. (The module index entries are generated from the module name and synopsis within module files.) --------- (cherry picked from commit 33a7094) Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com> Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Also extend the 'idlelib' section header. These additions affect both the displayed idle.html file and the contents.html file displayed by clicking the
Complete table of contentslink on the main docs.python.org page. (The module index entries are generated from the module name and synopsis within module files.)📚 Documentation preview 📚: https://cpython-previews--129727.org.readthedocs.build/