From: Jason R. Coombs <jaraco@jaraco.com>
Date: Mon, 3 Oct 2022 13:11:06 +0000 (-0400)
Subject: [3.10] gh-96845: Fix docs around importlib.abc.Traversable (GH-97515)
X-Git-Tag: v3.10.8~77
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=bead571e6a2752d111f4995bcd4a0c2c3b19c6b6;p=thirdparty%2FPython%2Fcpython.git

[3.10] gh-96845: Fix docs around importlib.abc.Traversable (GH-97515)

* [3.10] gh-96845: Correct reference to Traversable* classes.

* [3.10] gh-96845: Add a note about the pending move of resources.abcs.
---

diff --git a/Doc/library/importlib.rst b/Doc/library/importlib.rst
index 3981cc6f2d96..1addba3fb47f 100644
--- a/Doc/library/importlib.rst
+++ b/Doc/library/importlib.rst
@@ -854,6 +854,8 @@ ABC hierarchy::
 
        Read contents of self as text.
 
+    Note: In Python 3.11 and later, this class is found in ``importlib.resources.abc``.
+
 
 .. class:: TraversableResources
 
@@ -868,6 +870,8 @@ ABC hierarchy::
 
     .. versionadded:: 3.9
 
+    Note: In Python 3.11 and later, this class is found in ``importlib.resources.abc``.
+
 
 :mod:`importlib.resources` -- Resources
 ---------------------------------------
@@ -930,7 +934,7 @@ The following functions are available.
 
 .. function:: files(package)
 
-    Returns an :class:`importlib.resources.abc.Traversable` object
+    Returns an :class:`importlib.abc.Traversable` object
     representing the resource container for the package (think directory)
     and its resources (think files). A Traversable may contain other
     containers (think subdirectories).
@@ -942,7 +946,7 @@ The following functions are available.
 
 .. function:: as_file(traversable)
 
-    Given a :class:`importlib.resources.abc.Traversable` object representing
+    Given a :class:`importlib.abc.Traversable` object representing
     a file, typically from :func:`importlib.resources.files`, return
     a context manager for use in a :keyword:`with` statement.
     The context manager provides a :class:`pathlib.Path` object.