docs: Update CPython differences. - #19605
Conversation
Signed-off-by: Matt Trentini <matt.trentini@gmail.com>
Footnote labels that collided with a module-header hyperlink target of the same name (re, unicodedata, io) caused "Duplicate explicit target name" and downstream footnote-resolution errors. Also replace two :keyword: roles with literal text since Sphinx does not recognise "async"/"await" as keywords for that role. Verified with a full local `make -C docs html` (-W --keep-going), which now succeeds with no warnings. Signed-off-by: Matt Trentini <matt.trentini@gmail.com>
|
This is a very large diff to review. Is there any way to make it smaller, eg don't increase the last column width, just put things on two lines if it overflows? |
Widening the Status column to fit longer values (e.g. "Not implemented") touched every row's border/padding, making the diff much larger than the actual content change. Re-wrap the Status column to fit within each table's original width instead, growing only the rows that need it. Also shortens one footnote label (#specialnone -> #specnone) in python_36.rst, since it didn't fit even wrapped onto its own line within the original column width. Verified with a full local `make -C docs html` (-W --keep-going), which succeeds with no warnings, and confirmed the wrapped cell text renders identically (HTML collapses the inserted line break). Signed-off-by: Matt Trentini <matt.trentini@gmail.com>
Done, hopefully that's easier now? |
|
Thanks, that's a bit better, but still a lot to review. It would be helpful to separate out the commits changing the |
Can do, though it was such a small change (+6 lines total) it didn't seem worthwhile. Also be aware that 3.11-3.14 are completely new, we didn't have those files in the past. And 3.5-3.10 are about as readable as I can make it. But yes, the PR affects a lot of lines. :( I'm not convinced this is the most effective way to present the differences to CPython - but I can't think of an easier way to present it either. |
Summary
Update the CPython Differences docs.
There were some updates required in the existing 3.5-3.10 pages and this also adds new pages for 3.11-3.14.
Trade-offs and Alternatives
These are becoming increasingly challenging to maintain but I'm not sure of a better alternative!
Generative AI
I used generative AI tools when creating this PR, but a human has checked the
code and is responsible for the code and the description above.