[3.11] GH-99818: improve the documentation for zipfile.Path and Traversable (GH-101589) (#102266)

Automerge-Triggered-By: GH:FFY00
(cherry picked from commit 84181c1404)

Co-authored-by: Filipe Laíns <lains@riseup.net>
This commit is contained in:
Shantanu 2023-02-25 15:42:30 -08:00 committed by GitHub
parent c2f42f1778
commit 735ff5ae27
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 3 deletions

View file

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

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