docstring: drop useless heading ":py" domain in crossrefs

This commit is contained in:
Stefano Zacchiroli 2017-09-06 20:27:34 +02:00
parent e3c59f8fa9
commit 8a519af8f5
3 changed files with 5 additions and 5 deletions

View file

@ -6,11 +6,11 @@
class AbstractAttribute:
"""AbstractAttributes in a base class must be overridden by the subclass.
It's like the :py:func:`abc.abstractmethod` decorator, but for things that
It's like the :func:`abc.abstractmethod` decorator, but for things that
are explicitly attributes/properties, not methods, without the need for
empty method def boilerplate. Like abc.abstractmethod, the class containing
AbstractAttributes must inherit from :py:class:`abc.ABC` or use the
:py:class:`abc.ABCMeta` metaclass.
AbstractAttributes must inherit from :class:`abc.ABC` or use the
:class:`abc.ABCMeta` metaclass.
Usage example::

View file

@ -28,7 +28,7 @@ class SWHIndexingLister(SWHListerBase):
necessary/available, some indication of the URL or index for fetching the
next series of repository data.
See :py:class:`swh.lister.core.lister_base.SWHListerBase` for more details.
See :class:`swh.lister.core.lister_base.SWHListerBase` for more details.
This class cannot be instantiated. To create a new Lister for a source
code listing service that follows the model described above, you must

View file

@ -28,7 +28,7 @@ class ListerTaskBase(Task, metaclass=AbstractTaskMeta):
2. Refreshing the list of already discovered repositories.
If the hosting service is indexable (according to the requirements of
:py:class:`SWHIndexingLister`), then we can optionally partition the
:class:`SWHIndexingLister`), then we can optionally partition the
set of known repositories into sub-sets to distribute the work.
This means that there is a third possible Task type for Indexing