Skip to content

docs: remove stray spaces in documentation#148635

Closed
ttiee wants to merge 1 commit intopython:mainfrom
ttiee:docs-trivial-whitespace-fixes
Closed

docs: remove stray spaces in documentation#148635
ttiee wants to merge 1 commit intopython:mainfrom
ttiee:docs-trivial-whitespace-fixes

Conversation

@ttiee
Copy link
Copy Markdown

@ttiee ttiee commented Apr 16, 2026

Remove stray spaces in three documentation files:

  • Doc/library/readline.rst
  • Doc/tutorial/classes.rst
  • Doc/howto/logging-cookbook.rst

This is a documentation-only cleanup with no behavioral changes.


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

@ttiee ttiee requested a review from vsajip as a code owner April 16, 2026 00:49
@python-cla-bot
Copy link
Copy Markdown

python-cla-bot bot commented Apr 16, 2026

All commit authors signed the Contributor License Agreement.

CLA signed

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news labels Apr 16, 2026
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Apr 16, 2026
Copy link
Copy Markdown
Member

@picnixz picnixz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are they rendered as double whitespaces in general or is it just for rST reading? if the HTML is unchanged (and I assume it will be), I do not think it is necessaey to change them. We can clean this up when we change those files (we tend to reject cosmetic PRs)

@picnixz picnixz added the pending The issue will be closed if no feedback is provided label Apr 16, 2026
@ttiee
Copy link
Copy Markdown
Author

ttiee commented Apr 16, 2026

Are they rendered as double whitespaces in general or is it just for rST reading? if the HTML is unchanged (and I assume it will be), I do not think it is necessaey to change them. We can clean this up when we change those files (we tend to reject cosmetic PRs)

I checked the rendered output.

For the two double-space cases in readline.rst and classes.rst, you are right: they only affect source text / generated HTML source, and the rendered HTML is effectively unchanged because whitespace is collapsed.

For logging-cookbook.rst, default , -> default, does change the rendered text. That said, this is still a very small cosmetic docs fix, so I’m happy to drop the PR and leave such cleanups for future substantive edits to these files.

@ttiee ttiee closed this Apr 16, 2026
@picnixz
Copy link
Copy Markdown
Member

picnixz commented Apr 16, 2026

Thank you for your understanding! You can, if you want, fix the logging typo though (and others in the file if you find some)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir pending The issue will be closed if no feedback is provided skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

2 participants