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

… Traversable (pythonGH-101589) Automerge-Triggered-By: GH:FFY00 (cherry picked from commit 84181c1) Co-authored-by: Filipe Laíns <lains@riseup.net>
hauntsaninja · Feb 25, 2023 · c43e9c7 · c43e9c7
1 parent c2f42f1
commit c43e9c7
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/Doc/library/importlib.resources.abc.rst b/Doc/library/importlib.resources.abc.rst
@@ -86,9 +86,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
 
     .. attribute:: 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