From: Filipe Laíns Date: Mon, 20 Feb 2023 19:21:10 +0000 (+0000) Subject: GH-99818: improve the documentation for zipfile.Path and Traversable (GH-101589) X-Git-Tag: v3.12.0a6~117 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=84181c14040ed2befe7f1a55b4f560c80fa61154;p=thirdparty%2FPython%2Fcpython.git GH-99818: improve the documentation for zipfile.Path and Traversable (GH-101589) Automerge-Triggered-By: GH:FFY00 --- diff --git a/Doc/library/importlib.resources.abc.rst b/Doc/library/importlib.resources.abc.rst index 7747e89a833c..2d0f137ffc79 100644 --- a/Doc/library/importlib.resources.abc.rst +++ b/Doc/library/importlib.resources.abc.rst @@ -89,9 +89,12 @@ .. 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 .. deprecated-removed:: 3.12 3.14 diff --git a/Doc/library/zipfile.rst b/Doc/library/zipfile.rst index 1c516723f04a..0195abc3a992 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