[3.10] pythonGH-99818: improve the documentation for zipfile.Path and…

… Traversable (pythonGH-101589)
hauntsaninja · Feb 25, 2023 · 5ee1e73 · 5ee1e73
1 parent d22a2cd
commit 5ee1e73
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git 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
@@ -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