]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.13] Docs: Fix some semantic usages of `iterator.__iter__` (GH-130172) (GH-130543)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Wed, 26 Feb 2025 10:02:53 +0000 (11:02 +0100)
committerGitHub <noreply@github.com>
Wed, 26 Feb 2025 10:02:53 +0000 (11:02 +0100)
These references to an `__iter__` method mean `object.__iter__`, not `iterator.__iter__`.
(cherry picked from commit 4d3a7ea354a8ca7a9978f48e54399526d1b83f42)

Co-authored-by: Yuki Kobayashi <drsuaimqjgar@gmail.com>
Doc/glossary.rst
Doc/library/abc.rst
Doc/library/stdtypes.rst

index 267d8c0793e5be8eedd8baf6ce7eb7148b80aa2d..598f3961a1f321b94a39803283616148347b4d0e 100644 (file)
@@ -706,7 +706,7 @@ Glossary
       iterables include all sequence types (such as :class:`list`, :class:`str`,
       and :class:`tuple`) and some non-sequence types like :class:`dict`,
       :term:`file objects <file object>`, and objects of any classes you define
-      with an :meth:`~iterator.__iter__` method or with a
+      with an :meth:`~object.__iter__` method or with a
       :meth:`~object.__getitem__` method
       that implements :term:`sequence` semantics.
 
index 38d744e97d087d0b879de750a640703bff9efc18..49e541a9d9b1cb037c7273ab27d034a7573214ad 100644 (file)
@@ -141,18 +141,18 @@ a helper class :class:`ABC` to alternatively define ABCs through inheritance:
       MyIterable.register(Foo)
 
    The ABC ``MyIterable`` defines the standard iterable method,
-   :meth:`~iterator.__iter__`, as an abstract method.  The implementation given
+   :meth:`~object.__iter__`, as an abstract method.  The implementation given
    here can still be called from subclasses.  The :meth:`!get_iterator` method
    is also part of the ``MyIterable`` abstract base class, but it does not have
    to be overridden in non-abstract derived classes.
 
    The :meth:`__subclasshook__` class method defined here says that any class
-   that has an :meth:`~iterator.__iter__` method in its
+   that has an :meth:`~object.__iter__` method in its
    :attr:`~object.__dict__` (or in that of one of its base classes, accessed
    via the :attr:`~type.__mro__` list) is considered a ``MyIterable`` too.
 
    Finally, the last line makes ``Foo`` a virtual subclass of ``MyIterable``,
-   even though it does not define an :meth:`~iterator.__iter__` method (it uses
+   even though it does not define an :meth:`~object.__iter__` method (it uses
    the old-style iterable protocol, defined in terms of :meth:`~object.__len__` and
    :meth:`~object.__getitem__`).  Note that this will not make ``get_iterator``
    available as a method of ``Foo``, so it is provided separately.
index cb9624ab7573308cb0510bc625c03788339ac150..d910f49ed3a7550e25eda93115365d5505094277 100644 (file)
@@ -907,9 +907,9 @@ Generator Types
 ---------------
 
 Python's :term:`generator`\s provide a convenient way to implement the iterator
-protocol.  If a container object's :meth:`~iterator.__iter__` method is implemented as a
+protocol.  If a container object's :meth:`~object.__iter__` method is implemented as a
 generator, it will automatically return an iterator object (technically, a
-generator object) supplying the :meth:`!__iter__` and :meth:`~generator.__next__`
+generator object) supplying the :meth:`~iterator.__iter__` and :meth:`~generator.__next__`
 methods.
 More information about generators can be found in :ref:`the documentation for
 the yield expression <yieldexpr>`.