Skip to content

gh-101100: Fix Sphinx nitpicks in library/collections.abc.rst #113116

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
AlexWaygood merged 2 commits into from
Dec 14, 2023
Merged

gh-101100: Fix Sphinx nitpicks in library/collections.abc.rst #113116

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ebba43b
gh-101100: Fix Sphinx nitpicks in `library/collections.abc.rst`
AlexWaygood Dec 14, 2023
fe3486c
Address review
AlexWaygood Dec 14, 2023
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
Address review
  • Loading branch information
@AlexWaygood
AlexWaygood committed Dec 14, 2023
commit fe3486c00515b09076d5c99580fac079f72115dc
18 changes: 8 additions & 10 deletions Doc/library/collections.abc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,10 @@ of the API:
True

In this example, class :class:`!D` does not need to define
:meth:`~object.__contains__`, :meth:`~container.__iter__`, and
:meth:`~object.__reversed__` because the
``__contains__``, ``__iter__``, and ``__reversed__`` because the
:ref:`in-operator <comparisons>`, the :term:`iteration <iterable>`
logic, and the :func:`reversed` function automatically fall back to
using :meth:`~object.__getitem__` and :meth:`~object.__len__`.
using ``__getitem__`` and ``__len__``.

3) Some simple interfaces are directly recognizable by the presence of
the required methods (unless those methods have been set to
Expand All @@ -101,9 +100,9 @@ Complex interfaces do not support this last technique because an
interface is more than just the presence of method names. Interfaces
specify semantics and relationships between methods that cannot be
inferred solely from the presence of specific method names. For
example, knowing that a class supplies :meth:`~object.__getitem__`,
:meth:`~object.__len__`, and :meth:`~container.__iter__` is insufficient for
distinguishing a :class:`Sequence` from a :class:`Mapping`.
example, knowing that a class supplies ``__getitem__``, ``__len__``, and
``__iter__`` is insufficient for distinguishing a :class:`Sequence` from
a :class:`Mapping`.

.. versionadded:: 3.9
These abstract classes now support ``[]``. See :ref:`types-genericalias`
Expand Down Expand Up @@ -336,15 +335,14 @@ Collections Abstract Base Classes -- Detailed Descriptions

.. class:: AsyncIterable

ABC for classes that provide an :meth:`~object.__aiter__` method. See also
the definition of :term:`asynchronous iterable`.
ABC for classes that provide an ``__aiter__`` method. See also the
definition of :term:`asynchronous iterable`.

.. versionadded:: 3.5

.. class:: AsyncIterator

ABC for classes that provide :meth:`~object.__aiter__` and
:meth:`~object.__anext__`
ABC for classes that provide ``__aiter__`` and ``__anext__``
methods. See also the definition of :term:`asynchronous iterator`.

.. versionadded:: 3.5
Expand Down