From 39ecaca0eb9864b1311031b3a19ef2d04e32afb2 Mon Sep 17 00:00:00 2001 From: Sandip Hembram <139387472+sandiphembram2021@users.noreply.github.com> Date: Thu, 26 Jun 2025 00:03:56 +0530 Subject: [PATCH] docs: fix blank-line and section formatting in gui.rst ### 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. --- Doc/faq/gui.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/Doc/faq/gui.rst b/Doc/faq/gui.rst index cfa60feceb31b7..9199eee7c4172d 100644 --- a/Doc/faq/gui.rst +++ b/Doc/faq/gui.rst @@ -7,9 +7,7 @@ Graphic User Interface FAQ .. only:: html .. contents:: - -.. XXX need review for Python 3. - + .. contents:: General GUI Questions =====================