From c0295675305f6896e4ba7496441cc470d7edca89 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Filipe=20La=C3=ADns?= Date: Tue, 19 Oct 2021 01:52:28 +0100 Subject: bpo-45516: use documentation links in TraversableResources' description (GH-29045) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit I think this makes the documentation much more digestible :) Signed-off-by: Filipe Laíns --- Doc/library/importlib.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/Doc/library/importlib.rst b/Doc/library/importlib.rst index 3576941..1923057 100644 --- a/Doc/library/importlib.rst +++ b/Doc/library/importlib.rst @@ -859,10 +859,11 @@ ABC hierarchy:: .. class:: TraversableResources An abstract base class for resource readers capable of serving - the ``files`` interface. Subclasses ResourceReader and provides - concrete implementations of the ResourceReader's abstract - methods. Therefore, any loader supplying TraversableReader - also supplies ResourceReader. + the :meth:`importlib.resources.files` interface. Subclasses + :class:`importlib.abc.ResourceReader` and provides + concrete implementations of the :class:`importlib.abc.ResourceReader`'s + abstract methods. Therefore, any loader supplying + :class:`importlib.abc.TraversableReader` also supplies ResourceReader. Loaders that wish to support resource reading are expected to implement this interface. -- cgit v0.12