Skip to content

gh-141984: Move generator iterator reference out of syntax docs - #154884

Open
encukou wants to merge 6 commits into
python:mainfrom
encukou:move-generator-iterator-out
Open

gh-141984: Move generator iterator reference out of syntax docs#154884
encukou wants to merge 6 commits into
python:mainfrom
encukou:move-generator-iterator-out

Conversation

@encukou

@encukou encukou commented Jul 29, 2026

Copy link
Copy Markdown
Member

The Expressions section of the docs contains reference documentation (that is, descriptions of all the methods) for Generator-iterators and Asynchronous generator-iterators.
These look out of place here, and interfere with explaining the syntax around yield.

There are two places that would make a better home for these: stdtypes in Library and datamodel in Reference. (These two have a lot of overlap, for what I think are mostly historical reasons, but fixing that is out of scope for this PR.)
I think stdtypes is the better place to put these.

I added an introduction to Generators here, which currently overlaps a bit with the Yield expressions in the grammar docs. I'll be reworking Yield expressions next.

@read-the-docs-community

read-the-docs-community Bot commented Jul 29, 2026

Copy link
Copy Markdown

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

Labels

awaiting core review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

1 participant