Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

docs: fix blank-line and section formatting in gui.rst#135951

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Conversation

sandiphembram2021
Copy link

@sandiphembram2021sandiphembram2021 commentedJun 25, 2025
edited by github-actionsbot
Loading

Summary

This pull request improves the formatting of theDoc/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

  • Documentation changes only.
  • Follows reStructuredText formatting guidelines.
  • Tested with local build or preview tools.

📚 Documentation preview 📚:https://cpython-previews--135951.org.readthedocs.build/

### SummaryThis 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.---### JustificationMaintaining 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.
@python-cla-bot
Copy link

The following commit authors need to sign the Contributor License Agreement:

CLA signed

@StanFromIreland
Copy link
Member

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 thedevguide. You can also findour policy on AI usage there.

Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
awaiting reviewdocsDocumentation in the Doc dirskip news
Projects
Status: Todo
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

2 participants
@sandiphembram2021@StanFromIreland

[8]ページ先頭

©2009-2025 Movatter.jp