diff --git a/Doc/library/importlib.resources.abc.rst b/Doc/library/importlib.resources.abc.rst index 45979c5691270a..c488f811567753 100644 --- a/Doc/library/importlib.resources.abc.rst +++ b/Doc/library/importlib.resources.abc.rst @@ -172,14 +172,16 @@ .. class:: TraversableResources An abstract base class for resource readers capable of serving - the :meth:`importlib.resources.files` interface. Subclasses - :class:`ResourceReader` and provides - concrete implementations of the :class:`!ResourceReader`'s - abstract methods. Therefore, any loader supplying - :class:`!TraversableResources` also supplies :class:`!ResourceReader`. + the :meth:`importlib.resources.files` interface. This class inherits from + :class:`ResourceReader` and provides concrete implementations + of the :class:`!ResourceReader`'s abstract methods given the + provided ``files`` implementation. Therefore, any loader supplying + :class:`!TraversableResources` also supplies + :class:`!ResourceReader`. Loaders that wish to support resource reading are expected to - implement this interface. + implement this interface, instead of implementing + :class:`!ResourceReader` directly. .. method:: files() :abstractmethod: diff --git a/Misc/NEWS.d/next/Documentation/2021-10-22-22-12-18.bpo-45516.dcghqS.rst b/Misc/NEWS.d/next/Documentation/2021-10-22-22-12-18.bpo-45516.dcghqS.rst new file mode 100644 index 00000000000000..c85c505241e0c2 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2021-10-22-22-12-18.bpo-45516.dcghqS.rst @@ -0,0 +1 @@ +Improve :class:`importlib.abc.TraversableResources`'s documentation.