Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 1 commit into from
Feb 25, 2023
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion Doc/library/importlib.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down
5 changes: 3 additions & 2 deletions Doc/library/zipfile.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down