gh-101100: Fix some Sphinx reference warnings in whatsnew/2.6.rst #139236

rowanbudge · 2025-09-22T13:16:49Z

For gh-101100 - Fix all Sphinx reference warnings in the documentation #101100

Fix some of the issues in whatsnew/2.6.rst

Part of sprints at PyConUK 25

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

Also add a working link for abc.abstractmethod while there

python-cla-bot · 2025-09-22T13:16:53Z

All commit authors signed the Contributor License Agreement.

hugovk · 2025-09-22T13:26:50Z

@rowanbudge Looks like the CLA bot still needs appeasing. Please can you check it's signed with the same email address mentioned in the comment?

rowanvil · 2025-09-22T13:38:33Z

@rowanbudge Looks like the CLA bot still needs appeasing. Please can you check it's signed with the same email address mentioned in the comment?

I think this is done now, not sure when the github accounts got switched sorry!

Doc/whatsnew/2.6.rst

StanFromIreland · 2025-09-22T15:29:03Z

Doc/whatsnew/2.6.rst

-  and :meth:`close`.
+* :class:`~io.RawIOBase` defines raw I/O operations: :meth:`~io.RawIOBase.read`,
+  :meth:`~io.RawIOBase.readinto`,
+  :meth:`~io.RawIOBase.write`, :meth:`~io.IOBase.seek`, :meth:`~io.IOBase.tell`, :meth:`~io.IOBase.truncate`,


Please wrap lines to 79 characters.

I've wrapped at 79 lines in all the places already edited by this PR that I could spot

Thanks, however, it introduced a lot of trailing white space causing the lint CI to fail.

Yep aware and working on it

Checks now pass

On the other hand, rewrapping all edits makes it harder to review the actual changes in the diff, so it's a balance. (There's some discussion in python/devguide#1018.)

No need to unwrap though.

Also please avoid force-pushing -- everything gets squashed into a single commit at the end, and separate commits are easier to review. Thanks!

Doc/whatsnew/2.6.rst

now with pre-commit check to remove whitespace

Hopefully also resolve Block quote ends without a blank line; unexpected unindent.

hugovk

Thank you!

AA-Turner

Is this PR intended to resolve all warnings in the file? It's OK if not, just trying to get a sense of intended scope for the review.

A

hugovk · 2025-10-04T07:05:51Z

No, not all, just one sprint day's worth :)

We can fix the rest in future PRs.

miss-islington-app · 2025-10-04T15:59:43Z

Thanks @rowanbudge for the PR, and @AA-Turner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

….rst`` (pythonGH-139236) (cherry picked from commit 04a2f80) Co-authored-by: rowanbudge <[email protected]> Co-authored-by: rowanvil <[email protected]> Co-authored-by: Adam Turner <[email protected]>

bedevere-app · 2025-10-04T15:59:58Z

GH-139568 is a backport of this pull request to the 3.14 branch.

bedevere-app · 2025-10-04T16:00:02Z

GH-139569 is a backport of this pull request to the 3.13 branch.

AA-Turner · 2025-10-04T16:00:48Z

Thanks for this PR @rowanbudge and congratulations on your first contribution!

A

…6.rst`` (python#139236) Co-authored-by: rowanvil <[email protected]> Co-authored-by: Adam Turner <[email protected]>

rowanvil added 8 commits September 22, 2025 13:58

Ignore future_builtins

5eb56d1

Ignore sys.py3kwarning

d8f9ee0

Make example code reference literals for DatabaseConnection and Drawable

03605c4

Also add a working link for abc.abstractmethod while there

fix contextlib references

dd87800

fix multiprocessing references

e65c236

Fix New I/O Library refernces

82dfad3

Fix Abstract Base Classes references

b47e279

Ignore APPDATA

c8b77ec

rowanbudge requested a review from AA-Turner as a code owner September 22, 2025 13:16

bedevere-app bot added awaiting review docs Documentation in the Doc dir skip news labels Sep 22, 2025

github-project-automation bot added this to Docs PRs Sep 22, 2025

github-project-automation bot moved this to Todo in Docs PRs Sep 22, 2025

rowanbudge changed the title ~~Ignore future_builtins~~ gh-101100 : Fix Sphinx reference warnings in whatsnew/2.6.rst Sep 22, 2025

rowanbudge changed the title ~~gh-101100 : Fix Sphinx reference warnings in whatsnew/2.6.rst~~ gh-101100: Fix Sphinx reference warnings in whatsnew/2.6.rst Sep 22, 2025

StanFromIreland reviewed Sep 22, 2025

View reviewed changes

AA-Turner added the sprint label Sep 22, 2025

github-project-automation bot added this to Sprint 2024 Sep 22, 2025

github-project-automation bot moved this to Todo in Sprint 2024 Sep 22, 2025

rowanbudge force-pushed the fix-sphinx-warnings-in-whatsnew-2.6 branch from de1a24b to 63b5bd2 Compare September 23, 2025 15:56

StanFromIreland reviewed Sep 23, 2025

View reviewed changes

Doc/whatsnew/2.6.rst Outdated Show resolved Hide resolved

Review Changes - Wrap lines v2

3c94412

now with pre-commit check to remove whitespace

rowanbudge force-pushed the fix-sphinx-warnings-in-whatsnew-2.6 branch from b57ba9e to 3c94412 Compare September 23, 2025 16:16

Fix Unexpected indentation Warning

3c96755

Hopefully also resolve Block quote ends without a blank line; unexpected unindent.

hugovk approved these changes Oct 1, 2025

View reviewed changes

github-project-automation bot moved this from Todo to In Progress in Sprint 2024 Oct 1, 2025

bedevere-app bot added awaiting merge and removed awaiting review labels Oct 1, 2025

AA-Turner changed the title ~~gh-101100: Fix Sphinx reference warnings in whatsnew/2.6.rst~~ gh-101100: Fix some Sphinx reference warnings in whatsnew/2.6.rst Oct 4, 2025

AA-Turner reviewed Oct 4, 2025

View reviewed changes

Tweaks

53b1682

AA-Turner approved these changes Oct 4, 2025

View reviewed changes

AA-Turner added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Oct 4, 2025

AA-Turner enabled auto-merge (squash) October 4, 2025 15:53

AA-Turner merged commit 04a2f80 into python:main Oct 4, 2025
31 checks passed

github-project-automation bot moved this from In Progress to Done in Sprint 2024 Oct 4, 2025

github-project-automation bot moved this from Todo to Done in Docs PRs Oct 4, 2025

bedevere-app bot removed the awaiting merge label Oct 4, 2025

bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Oct 4, 2025

bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Oct 4, 2025

danigm pushed a commit to openSUSE-Python/cpython that referenced this pull request Oct 7, 2025

pythongh-101100: Fix some Sphinx reference warnings in ``whatsnew/2.…

87fb8ed

…6.rst`` (python#139236) Co-authored-by: rowanvil <[email protected]> Co-authored-by: Adam Turner <[email protected]>

Uh oh!

gh-101100: Fix some Sphinx reference warnings in whatsnew/2.6.rst #139236

gh-101100: Fix some Sphinx reference warnings in whatsnew/2.6.rst #139236

Conversation

rowanbudge commented Sep 22, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

python-cla-bot bot commented Sep 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

hugovk commented Sep 22, 2025

Uh oh!

rowanvil commented Sep 22, 2025

Uh oh!

Uh oh!

StanFromIreland Sep 22, 2025

Choose a reason for hiding this comment

Uh oh!

rowanvil Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

StanFromIreland Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

rowanvil Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

rowanvil Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

hugovk Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

hugovk left a comment

Choose a reason for hiding this comment

Uh oh!

AA-Turner left a comment

Choose a reason for hiding this comment

Uh oh!

hugovk commented Oct 4, 2025

Uh oh!

Uh oh!

miss-islington-app bot commented Oct 4, 2025

Uh oh!

bedevere-app bot commented Oct 4, 2025

Uh oh!

bedevere-app bot commented Oct 4, 2025

Uh oh!

AA-Turner commented Oct 4, 2025

Uh oh!

Uh oh!

rowanbudge commented Sep 22, 2025 •

edited by github-actions bot

Loading

python-cla-bot bot commented Sep 22, 2025 •

edited

Loading