Skip to content

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

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

Merged
miss-islington merged 2 commits into from
Feb 20, 2023
Merged

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

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a52c7d6
GH-99189: improve the documentation for zipfile.Path and Traversable
FFY00 Feb 5, 2023
6af277a
Update Doc/library/importlib.resources.abc.rst
FFY00 Feb 20, 2023
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
Next Next commit
GH-99189: improve the documentation for zipfile.Path and Traversable
  • Loading branch information
@FFY00
FFY00 committed Feb 5, 2023
commit a52c7d63e6754ced873f573981053591cf842832
5 changes: 4 additions & 1 deletion Doc/library/importlib.resources.abc.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

If you need a representation of the object on the file-system, you can use
:meth:`importlib.resources.as_file`.
Comment thread
FFY00 marked this conversation as resolved.
Outdated

.. versionadded:: 3.9

.. deprecated-removed:: 3.12 3.14
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