gh-141984: Move generator iterator reference out of syntax docs - #154884
Open
encukou wants to merge 6 commits into
Open
gh-141984: Move generator iterator reference out of syntax docs#154884encukou wants to merge 6 commits into
encukou wants to merge 6 commits into
Conversation
Co-authored-by: Blaise Pabon <blaise@gmail.com>
Documentation build overview
21 files changed ·
|
| methods. | ||
| More information about generators can be found in :ref:`the documentation for | ||
| the yield expression <yieldexpr>`. | ||
| Python's :term:`generators <generator>` -- or more precisely, |
| For example:: | ||
|
|
||
| >>> class CardDeck: | ||
| ... def __iter__(self): |
Member
There was a problem hiding this comment.
Inconsistent indentation.
| ... yield 'ace of hearts' | ||
|
|
||
| >>> list(CardDeck()) | ||
| ... ['three of clubs', 'ace of hearts'] |
Member
There was a problem hiding this comment.
Suggested change
| ... ['three of clubs', 'ace of hearts'] | |
| ['three of clubs', 'ace of hearts'] |
| .. index:: pair: object; asynchronous-generator | ||
| .. _asynchronous-generator-methods: | ||
|
|
||
| Asynchronous generator-iterators |
Member
There was a problem hiding this comment.
Suggested change
| Asynchronous generator-iterators | |
| Asynchronous generator iterators |
| Asynchronous generator-iterators | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| This subsection describes the methods of an asynchronous generator iterator, |
Member
There was a problem hiding this comment.
An expanded introduction would be nice here, too. Although that can be done in a follow up.
| awaitable instead raises a :exc:`StopAsyncIteration` exception, | ||
| signalling that the asynchronous iteration has completed. | ||
|
|
||
| This method is normally called implicitly by a :keyword:`async for` loop, |
Member
There was a problem hiding this comment.
Suggested change
| This method is normally called implicitly by a :keyword:`async for` loop, | |
| This method is normally called implicitly by an :keyword:`async for` loop, |
| returns the next yielded value as the value of the raised | ||
| :exc:`StopIteration`, or raises :exc:`StopAsyncIteration`. | ||
|
|
||
| :meth:`asend` is called to start the asynchronous |
Member
There was a problem hiding this comment.
Suggested change
| :meth:`asend` is called to start the asynchronous | |
| When :meth:`asend` is called to start the asynchronous |
lost during the refactor.
| For backwards compatibility, however, the second signature is | ||
| supported. | ||
| An exception instance is created from three arguments in the same way as in | ||
| :meth:`generator.throw` |
Member
There was a problem hiding this comment.
Suggested change
| :meth:`generator.throw` | |
| :meth:`generator.throw`. |
| using/windows.html: virtual-environments | ||
| using/windows.html: windows-full | ||
|
|
||
| # Moved to library/stdtypes: |
Member
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.