Skip to content

Commit 735ff5a

Browse files
hauntsaninjaFFY00
andauthored
[3.11] GH-99818: improve the documentation for zipfile.Path and Traversable (GH-101589) (#102266)
Automerge-Triggered-By: GH:FFY00 (cherry picked from commit 84181c1) Co-authored-by: Filipe Laíns <[email protected]>
1 parent c2f42f1 commit 735ff5a

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

Doc/library/importlib.resources.abc.rst

+4-1
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,12 @@
8686

8787
.. class:: Traversable
8888

89-
An object with a subset of pathlib.Path methods suitable for
89+
An object with a subset of :class:`pathlib.Path` methods suitable for
9090
traversing directories and opening files.
9191

92+
For a representation of the object on the file-system, use
93+
:meth:`importlib.resources.as_file`.
94+
9295
.. versionadded:: 3.9
9396

9497
.. attribute:: name

Doc/library/zipfile.rst

+3-2
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,9 @@ The module defines the following items:
5555
.. class:: Path
5656
:noindex:
5757

58-
A pathlib-compatible wrapper for zip files. See section
59-
:ref:`path-objects` for details.
58+
Class that implements a subset of the interface provided by
59+
:class:`pathlib.Path`, including the full
60+
:class:`importlib.resources.abc.Traversable` interface.
6061

6162
.. versionadded:: 3.8
6263

0 commit comments

Comments
 (0)