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

[3.12] Link to correct class methods in asyncio primitives docs (GH-127270) #127438

Merged

Conversation

picnixz
Copy link
Contributor

@picnixz picnixz commented Nov 30, 2024

(cherry picked from commit 15d6506)

Co-authored-by: Ollanta Cuba Gyllensten [email protected]

@kumaraditya303
I've checked that wait_for does indeed call wait() before checking the predicate but I'd like to know whether this additional paragraph for wait is needed or not:

Note

Note that a task may return from this call spuriously,
which is why the caller should always re-check the state
and be prepared to :meth:~Condition.wait again. For this reason, you may
prefer to use :meth:~Condition.wait_for instead.


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

@kumaraditya303
Copy link
Contributor

I've checked that wait_for does indeed call wait() before checking the predicate but I'd like to know whether this additional paragraph for wait is needed or not:

Can you just fix the links and not add this para? That change dates back to #112201 which isn't present in 3.12 AFAIK.

This removes the irrelevant note for 3.12.
@picnixz
Copy link
Contributor Author

picnixz commented Nov 30, 2024

Done. I can also remove the paragraph "The method will repeatedly :meth:`~Condition.wait` until the predicate evaluates to *true*." if you think we shouldn't improve the 3.12 docs with this note.

@kumaraditya303 kumaraditya303 enabled auto-merge (squash) November 30, 2024 10:01
@kumaraditya303 kumaraditya303 merged commit ea8a85b into python:3.12 Nov 30, 2024
25 checks passed
@picnixz picnixz deleted the bp-15d6506d175780bb29e5fcde654e3860408aa93e branch November 30, 2024 10:02
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