GH-99818: improve the documentation for zipfile.Path and Traversable (GH-101589)

Automerge-Triggered-By: GH:FFY00
This commit is contained in:
Filipe Laíns 2023-02-20 19:21:10 +00:00 committed by GitHub
parent 59e86caca8
commit 84181c1404
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 3 deletions

View File

@ -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

View File

@ -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