8000 bpo-45250: fix docs regarding `__iter__` and iterators being inconsistently required by CPython by brettcannon · Pull Request #29170 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

bpo-45250: fix docs regarding __iter__ and iterators being inconsistently required by CPython #29170

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

Merged
merged 12 commits into from
Nov 20, 2021
Merged

bpo-45250: fix docs regarding __iter__ and iterators being inconsistently required by CPython #29170

Changes from 1 commit
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
867a96e
Update the glossary
brettcannon Oct 22, 2021
ff97128
Add a news entry
brettcannon Oct 22, 2021
aaddd9f
Update the built-in functions
brettcannon Oct 22, 2021
2b11e3f
Add some glossary links to the data model
brettcannon Oct 22, 2021
5224d4d
Update stdtypes.rst
brettcannon Oct 22, 2021
7ee081a
Clarify collections.abc docs
brettcannon Oct 22, 2021
ad88009
Add glossary links to the C API for iterators
brettcannon Oct 22, 2021
7dccf4b
Fix issues found via review
brettcannon Oct 22, 2021
1dcceb9
Clarify the docs for collections.abc.AsyncIterator
brettcannon Oct 26, 2021
15ac1e2
Remove a reference to `__iter__()` having to be defined on iterators …
brettcannon Nov 1, 2021
91d86cf
Revert some changes
brettcannon Nov 20, 2021
e0286fe
Clarify that CPython is inconsistent when it comes to requiring itera…
brettcannon Nov 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Clarify the docs for collections.abc.AsyncIterator
  • Loading branch information
@brettcannon
brettcannon committed Oct 26, 2021
commit 1dcceb9503ec3549da393cfb20b95d977590a2b7
5 changes: 3 additions & 2 deletions Doc/library/collections.abc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -334,8 +334,9 @@ Collections Abstract Base Classes -- Detailed Descriptions

.. class:: AsyncIterator

ABC for classes that provide ``__aiter__`` and ``__anext__``
methods. See also the definition of :term:`asynchronous iterator`.
ABC for classes that provide the ``__anext__`` method. An implementation
of ``__aiter__`` is provided for convenience. See also the definition of
:term:`asynchronous iterator`.

.. versionadded:: 3.5

Expand Down
0