Skip to content

Link to correct class methods in asyncio primitives docs#127270

Merged
kumaraditya303 merged 1 commit intopython:mainfrom
ollanta:asyncio-documentation-fixes
Nov 29, 2024
Merged

Link to correct class methods in asyncio primitives docs#127270
kumaraditya303 merged 1 commit intopython:mainfrom
ollanta:asyncio-documentation-fixes

Conversation

@ollanta
Copy link
Contributor

@ollanta ollanta commented Nov 25, 2024

The documentation for asyncio Condition and Barrier links to :meth:wait and :meth:wait_for. This resolves to asyncio.wait and asyncio.wait_for instead of the respective class methods.

Changing this to eg :meth:~Condition.wait fixes the issue.


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

The documentation for asyncio Condition and Barrier links to :meth:`wait` and :meth:`wait_for`.
This resolves to asyncio.wait and asyncio.wait_for instead of the respective class methods.
Changing to eg :meth:`~Condition.wait` fixes this.
@ghost
Copy link

ghost commented Nov 25, 2024

All commit authors signed the Contributor License Agreement.
CLA signed

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels Nov 25, 2024
@miss-islington-app
Copy link

Thanks @ollanta for the PR, and @kumaraditya303 for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 29, 2024
…7270)

(cherry picked from commit 15d6506)

Co-authored-by: Ollanta Cuba Gyllensten <ollantaster@gmail.com>
@miss-islington-app
Copy link

Sorry, @ollanta and @kumaraditya303, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 15d6506d175780bb29e5fcde654e3860408aa93e 3.12

@bedevere-app
Copy link

bedevere-app bot commented Nov 29, 2024

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

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Nov 29, 2024
kumaraditya303 pushed a commit that referenced this pull request Nov 29, 2024
…27270) (#127423)

Link to correct class methods in asyncio primitives docs (GH-127270)
(cherry picked from commit 15d6506)

Co-authored-by: Ollanta Cuba Gyllensten <ollantaster@gmail.com>
@picnixz

This comment was marked as resolved.

@bedevere-app
Copy link

bedevere-app bot commented Nov 30, 2024

GH-127438 is a backport of this pull request to the 3.12 branch.

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

Labels

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants