]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-45516: use documentation links in TraversableResources' description (GH-29045)
authorFilipe Laíns <lains@riseup.net>
Tue, 19 Oct 2021 00:52:28 +0000 (01:52 +0100)
committerGitHub <noreply@github.com>
Tue, 19 Oct 2021 00:52:28 +0000 (20:52 -0400)
I think this makes the documentation much more digestible :)

Signed-off-by: Filipe Laíns <lains@riseup.net>
Doc/library/importlib.rst

index 3576941efa46d96695c08da51fef1eee4a7c7a24..19230570f2d5fc088285c2ce4354d5e50273009d 100644 (file)
@@ -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.