8000 Link to correct class methods in asyncio primitives docs by ollanta · Pull Request #127270 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

Link to correct class methods in asyncio primitives docs #127270

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Nov 29, 2024
Merged

Link to correct class methods in asyncio primitives docs #127270

merged 1 commit into from
Nov 29, 2024

Conversation

ollanta
Copy link
Contributor
@ollanta ollanta commented Nov 25, 2024 •
edited by github-actions bot
Loading

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/

@ollanta
Link to correct methods in asyncio primitives docs
8000
e40bfeb 
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 •
edited by ghost
Loading

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
@kumaraditya303 kumaraditya303 enabled auto-merge (squash) November 29, 2024 16:20
@kumaraditya303 kumaraditya303 merged commit 15d6506 into python:main Nov 29, 2024
48 checks passed
@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
@ollanta @miss-islington
Link to correct class methods in asyncio primitives docs (pythonGH-12…
ceac526 
…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
@miss-islington @ollanta
[3.13] Link to correct class methods in asyncio primitives docs (GH-1…
ee57221 
…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.

Sign in to view
@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.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Nov 30, 2024
kumaraditya303 pushed a commit that referenced this pull request Nov 30, 2024
@picnixz
[3.12] Link to correct class methods in asyncio primitives docs (GH-1…
ea8a85b 
…27270) (#127438)
picnixz pushed a commit to picnixz/cpython that referenced this pull request Dec 2, 2024
@ollanta @picnixz
Link to correct class methods in asyncio primitives docs (python#127270)
bf669ed
srinivasreddy pushed a commit to srinivasreddy/cpython that referenced this pull request Jan 8, 2025
@ollanta @srinivasreddy
Link to correct class methods in asyncio primitives docs (python#127270)
761f790
ebonnal pushed a commit to ebonnal/cpython that referenced this pull request Jan 12, 2025
@ollanta @ebonnal
Link to correct class methods in asyncio primitives docs (python#127270)
6460910
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kumaraditya303 kumaraditya303 kumaraditya303 approved these changes

@1st1 1st1 Awaiting requested review from 1st1 1st1 is a code owner

@asvetlov asvetlov Awaiting requested review from asvetlov asvetlov is a code owner

@willingc willingc Awaiting requested review from willingc willingc is a code owner

Assignees

@kumaraditya303 kumaraditya303

Labels
docs Documentation in the Doc dir skip issue skip news topic-asyncio
Projects
Docs PRs
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ollanta @picnixz @kumaraditya303
0