From 4667c4dcdefb810bcde045db651c585c3bbc36bb Mon Sep 17 00:00:00 2001 From: Shantanu <12621235+hauntsaninja@users.noreply.github.com> Date: Sat, 25 Feb 2023 15:40:55 -0800 Subject: [PATCH] [3.10] GH-99818: improve the documentation for zipfile.Path and Traversable (GH-101589) (#102267) --- Doc/library/importlib.rst | 5 ++++- Doc/library/zipfile.rst | 5 +++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/Doc/library/importlib.rst b/Doc/library/importlib.rst index 20305150d648a9..21c19903464972 100644 --- a/Doc/library/importlib.rst +++ b/Doc/library/importlib.rst @@ -809,9 +809,12 @@ ABC hierarchy:: .. class:: Traversable - An object with a subset of pathlib.Path methods suitable for + An object with a subset of :class:`pathlib.Path` methods suitable for traversing directories and opening files. + For a representation of the object on the file-system, use + :meth:`importlib.resources.as_file`. + .. versionadded:: 3.9 .. abstractmethod:: name() diff --git a/Doc/library/zipfile.rst b/Doc/library/zipfile.rst index eab1eaf4312d29..5072daa6335428 100644 --- a/Doc/library/zipfile.rst +++ b/Doc/library/zipfile.rst @@ -55,8 +55,9 @@ The module defines the following items: .. class:: Path :noindex: - A pathlib-compatible wrapper for zip files. See section - :ref:`path-objects` for details. + Class that implements a subset of the interface provided by + :class:`pathlib.Path`, including the full + :class:`importlib.resources.abc.Traversable` interface. .. versionadded:: 3.8