docs: fix blank-line and section formatting in gui.rst #135951
Closed
+1
−3
Conversation
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
### Summary This pull request improves the formatting of the `Doc/faq/gui.rst` file in the Python documentation. It addresses several issues related to blank lines, indentation, and section spacing to enhance the structure and readability of the document. --- ### Changes Made - Added a missing blank line after the `.. only:: html` directive to ensure correct rendering. - Inserted blank lines after section headers such as "General GUI Questions" and "Tkinter Questions" to maintain consistency. - Adjusted paragraph spacing and alignment for better formatting in HTML output. - Ensured proper indentation for reStructuredText directives and sections. --- ### Justification Maintaining proper formatting in reStructuredText (`.rst`) files is essential for consistent rendering of documentation in HTML and PDF formats. These changes improve the structural clarity of the GUI FAQ section and reduce the chance of misrendering or broken layouts during documentation builds. --- ### Impact - No functional or behavioral changes to Python or its standard library. - Documentation-only edits focused on formatting and style. - Improves the visual output and maintainability of the official Python docs. --- ### Checklist - [x] Documentation changes only. - [x] Follows reStructuredText formatting guidelines. - [x] Tested with local build or preview tools.
|
The following commit authors need to sign the Contributor License Agreement: |
bedevere-app
bot
added
awaiting review
docs
|
Welcome to contributing to CPython! Unfortunately I am have closed this PR because it simply introduces an error (double contents), and I do not see any existing errors that it intended to fix, and the description describes. If you would like to contribute to CPython, I recommend you first read the devguide. You can also find our policy on AI usage there. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
This pull request improves the formatting of the
Doc/faq/gui.rstfile in the Python documentation. It addresses several issues related to blank lines, indentation, and section spacing to enhance the structure and readability of the document.Changes Made
.. only:: htmldirective to ensure correct rendering.Justification
Maintaining proper formatting in reStructuredText (
.rst) files is essential for consistent rendering of documentation in HTML and PDF formats. These changes improve the structural clarity of the GUI FAQ section and reduce the chance of misrendering or broken layouts during documentation builds.Impact
Checklist
📚 Documentation preview 📚: https://cpython-previews--135951.org.readthedocs.build/