Skip to content

Commit

Permalink
[3.10] gh-96845: Fix docs around importlib.abc.Traversable (GH-97515)
Browse files Browse the repository at this point in the history
* [3.10] gh-96845: Correct reference to Traversable* classes.

* [3.10] gh-96845: Add a note about the pending move of resources.abcs.
  • Loading branch information
jaraco authored Oct 3, 2022
1 parent a1711ef commit bead571
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions Doc/library/importlib.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
---------------------------------------
Expand Down Expand Up @@ -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).
Expand All @@ -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.
Expand Down

0 comments on commit bead571

Please sign in to comment.