Issue #18758: Fixed and improved cross-references.

This commit is contained in:
Serhiy Storchaka 2013-10-13 23:09:14 +03:00
parent 24201d497c
commit bfdcd436f0
40 changed files with 144 additions and 125 deletions

View file

@ -110,19 +110,19 @@ This module provides the following class:
MyIterable.register(Foo)
The ABC ``MyIterable`` defines the standard iterable method,
:meth:`__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.
:meth:`~iterator.__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:`__iter__` method in its :attr:`__dict__` (or in that of
one of its base classes, accessed via the :attr:`__mro__` list) is
considered a ``MyIterable`` too.
that has an :meth:`~iterator.__iter__` method in its
:attr:`~object.__dict__` (or in that of one of its base classes, accessed
via the :attr:`~class.__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:`__iter__` method (it uses the
old-style iterable protocol, defined in terms of :meth:`__len__` and
even though it does not define an :meth:`~iterator.__iter__` method (it uses
the old-style iterable protocol, defined in terms of :meth:`__len__` and
:meth:`__getitem__`). Note that this will not make ``get_iterator``
available as a method of ``Foo``, so it is provided separately.