From 5ee1e73af082bc0d950d86a6d4bb9c87102c0495 Mon Sep 17 00:00:00 2001 From: hauntsaninja Date: Sat, 25 Feb 2023 15:29:43 -0800 Subject: [PATCH] [3.10] GH-99818: improve the documentation for zipfile.Path and Traversable (GH-101589) --- 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 pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy