diff options
author | Yury Selivanov <yselivanov@sprymix.com> | 2015-06-24 15:04:15 (GMT) |
---|---|---|
committer | Yury Selivanov <yselivanov@sprymix.com> | 2015-06-24 15:04:15 (GMT) |
commit | 66f8828bfce4a05cb5e27ed89bba46cdfc64f995 (patch) | |
tree | 1ad1dac376e1af397092b1acd5cd0f82732d31d0 /Doc/library/collections.abc.rst | |
parent | fcba97242b5ff446849e704926f51ce61355ee0b (diff) | |
download | cpython-66f8828bfce4a05cb5e27ed89bba46cdfc64f995.zip cpython-66f8828bfce4a05cb5e27ed89bba46cdfc64f995.tar.gz cpython-66f8828bfce4a05cb5e27ed89bba46cdfc64f995.tar.bz2 |
Issue #24439: Improve PEP 492 related docs.
Patch by Martin Panter.
Diffstat (limited to 'Doc/library/collections.abc.rst')
-rw-r--r-- | Doc/library/collections.abc.rst | 19 |
1 files changed, 10 insertions, 9 deletions
diff --git a/Doc/library/collections.abc.rst b/Doc/library/collections.abc.rst index 8c710ef..0653d4e 100644 --- a/Doc/library/collections.abc.rst +++ b/Doc/library/collections.abc.rst @@ -154,21 +154,22 @@ ABC Inherits from Abstract Methods Mixin .. class:: Awaitable - ABC for classes that provide ``__await__`` method. Instances - of such classes can be used in ``await`` expression. + ABC for :term:`awaitable` objects, which can be used in :keyword:`await` + expressions. Custom implementations must provide the :meth:`__await__` + method. - :term:`coroutine` objects and instances of - :class:`~collections.abc.Coroutine` are too instances of this ABC. + :term:`Coroutine` objects and instances of the + :class:`~collections.abc.Coroutine` ABC are all instances of this ABC. .. versionadded:: 3.5 .. class:: Coroutine - ABC for coroutine compatible classes that implement a subset of - generator methods defined in :pep:`342`, namely: - :meth:`~generator.send`, :meth:`~generator.throw`, - :meth:`~generator.close` methods. :meth:`__await__` must also be - implemented. All :class:`Coroutine` instances are also instances of + ABC for coroutine compatible classes. These implement the + following methods, defined in :ref:`coroutine-objects`: + :meth:`~coroutine.send`, :meth:`~coroutine.throw`, and + :meth:`~coroutine.close`. Custom implementations must also implement + :meth:`__await__`. All :class:`Coroutine` instances are also instances of :class:`Awaitable`. See also the definition of :term:`coroutine`. .. versionadded:: 3.5 |