diff options
| author | Filipe Laíns <lains@riseup.net> | 2021-10-19 00:52:28 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-10-19 00:52:28 (GMT) |
| commit | c0295675305f6896e4ba7496441cc470d7edca89 (patch) | |
| tree | e4b844f0fdf053c29d77818122aa32efbe0a27b9 | |
| parent | 5f09bb021a2862ba89c3ecb53e7e6e95a9e07e1d (diff) | |
| download | cpython-c0295675305f6896e4ba7496441cc470d7edca89.zip cpython-c0295675305f6896e4ba7496441cc470d7edca89.tar.gz cpython-c0295675305f6896e4ba7496441cc470d7edca89.tar.bz2 | |
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>
| -rw-r--r-- | Doc/library/importlib.rst | 9 |
1 files 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. |