[Python-checkins] bpo-45516: use documentation links in TraversableResources' description (GH-29045)
jaraco
webhook-mailer at python.org
Mon Oct 18 20:52:37 EDT 2021
https://github.com/python/cpython/commit/c0295675305f6896e4ba7496441cc470d7edca89
commit: c0295675305f6896e4ba7496441cc470d7edca89
branch: main
author: Filipe Laíns <lains at riseup.net>
committer: jaraco <jaraco at jaraco.com>
date: 2021-10-18T20:52:28-04:00
summary:
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 at riseup.net>
files:
M Doc/library/importlib.rst
diff --git a/Doc/library/importlib.rst b/Doc/library/importlib.rst
index 3576941efa46d..19230570f2d5f 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.
More information about the Python-checkins
mailing list