Skip to content

Conversation

@benediktjohannes
Copy link
Contributor

@benediktjohannes benediktjohannes commented Jan 25, 2026

This PR fixes a visual bug in the documentation (pep 373).


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

@benediktjohannes
Copy link
Contributor Author

@skirpichev thanks for the Information, this is a doc fix.

Copy link
Member

@StanFromIreland StanFromIreland left a comment

Choose a reason for hiding this comment

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

What is the issue with the current state?

@benediktjohannes
Copy link
Contributor Author

Hi, thanks for the question! If you Open up the docs document, Then there is a Blue line underlined and its buggy showing the pep Text in the Preview in the wrong way.

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
@picnixz
Copy link
Member

picnixz commented Jan 26, 2026

image

There is nothing wrong with that IMO. We do not necessarily want to show that it's PEP-373 (no one really cares about the PEP number, we care about the fact that we know that it's deprecated). The PR changes it to:

image

@picnixz
Copy link
Member

picnixz commented Jan 26, 2026

Btw, what do you mean by "Text in the Preview"? if it's not the usual HTML rendering, the bug may not be in the reference but may be in Sphinx itself

@benediktjohannes
Copy link
Contributor Author

Yeah, you're right, so for me it looks like this:

@picnixz
Copy link
Member

picnixz commented Jan 26, 2026

Yeah, you're right, so for me it looks like this:

I'm sorry but there is no screenshot

@benediktjohannes
Copy link
Contributor Author

Here is the old version
old version preview

@benediktjohannes
Copy link
Contributor Author

Yeah, you're right, so for me it looks like this:

I'm sorry but there is no screenshot

Yes, sorry, I wanted to just answer quickly so that you're still online and then add the screenshot right now

@benediktjohannes
Copy link
Contributor Author

How to reproduce this:

  1. Start e.g. windows sandbox for a absolutely new setup virtual machine (or at least a new setup browser)
  2. Open this on GitHub via https://github.com/python/cpython/blob/main/Doc/faq/general.rst
  3. See the result (as it is for me)

@picnixz
Copy link
Member

picnixz commented Jan 26, 2026

Oh if you are looking at the file from GH, it's normal. That's because GitHub doesn't support the full Sphinx syntax. You need to look at the online docs (https://docs.python.org/) if you are interested in fixing typos.

As such, I'm going to close this PR. Sorry!

@picnixz picnixz closed this Jan 26, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

3 participants