Skip to content

Conversation

@ZeroIntensity
Copy link
Member

@ZeroIntensity ZeroIntensity commented Nov 11, 2025

I didn't do PyAsyncGenASend_CheckExact in this one because I think that should just be deprecated.


📚 Documentation preview 📚: https://cpython-previews--141409.org.readthedocs.build/en/141409/c-api/gen.html#c.PyGen_GetCode

@ZeroIntensity ZeroIntensity added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels Nov 11, 2025
@bedevere-app bedevere-app bot added awaiting core review docs Documentation in the Doc dir skip news labels Nov 11, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Nov 11, 2025
Copy link
Member

@vstinner vstinner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, I just have minor suggestions.

.. c:function:: int PyAsyncGen_CheckExact(PyObject *op)
Return true if *op* is an asynchronous generator object, false otherwise.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Return true if *op* is an asynchronous generator object, false otherwise.
Return non-zero if *op* is an asynchronous generator object, zero otherwise.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We say "true" and "false" in this file (see PyGen_Check* above), and I'd rather be consistent.

Co-authored-by: Victor Stinner <vstinner@python.org>
@ZeroIntensity ZeroIntensity merged commit 2da7ecc into python:main Nov 20, 2025
28 checks passed
@ZeroIntensity ZeroIntensity deleted the document-pygen branch November 20, 2025 13:46
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Nov 20, 2025
@miss-islington-app
Copy link

Thanks @ZeroIntensity for the PR 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 20, 2025
(cherry picked from commit 2da7ecc)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
@bedevere-app
Copy link

bedevere-app bot commented Nov 20, 2025

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Nov 20, 2025
(cherry picked from commit 2da7ecc)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Nov 20, 2025
@bedevere-app
Copy link

bedevere-app bot commented Nov 20, 2025

GH-141790 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 20, 2025
ZeroIntensity added a commit that referenced this pull request Nov 20, 2025
)

gh-141004: Document missing generator APIs (GH-141409)
(cherry picked from commit 2da7ecc)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
ZeroIntensity added a commit that referenced this pull request Nov 20, 2025
)

gh-141004: Document missing generator APIs (GH-141409)
(cherry picked from commit 2da7ecc)

Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation in the Doc dir skip news

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants