From: Filipe Laíns <lains@riseup.net>
Date: Tue, 19 Oct 2021 00:52:28 +0000 (+0100)
Subject: bpo-45516: use documentation links in TraversableResources' description (GH-29045)
X-Git-Tag: v3.11.0a2~160
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=c0295675305f6896e4ba7496441cc470d7edca89;p=thirdparty%2FPython%2Fcpython.git

bpo-45516: use documentation links in TraversableResources' description (GH-29045)

I think this makes the documentation much more digestible :)

Signed-off-by: Filipe Laíns <lains@riseup.net>
---

diff --git a/Doc/library/importlib.rst b/Doc/library/importlib.rst
index 3576941efa46..19230570f2d5 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.