Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Link to correct class methods in asyncio primitives docs #127270

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ollanta
Copy link

@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.
Copy link

cpython-cla-bot bot 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
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 skip news
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

1 participant