Thanks to visit codestin.com
Credit goes to github.com

Skip to content

gh-93610: Improve docs for importlib.resources #93611

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
merged 18 commits into from
Jul 25, 2022
Merged

gh-93610: Improve docs for importlib.resources #93611

Changes from 1 commit
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
6a97526
Add a concrete example of why you'd use importlib.resources over Path…
encukou Jun 8, 2022
77b50ae
Link to the definition of a new term
encukou Jun 8, 2022
89f00a2
Add importlib.resources.abc docs to the hierarchy, to fix links
encukou Jun 8, 2022
9134901
Package: Document what this is first, then give the formal definition
encukou Jun 8, 2022
0274515
Shorten links to Traversable
encukou Jun 8, 2022
39ab32a
Link to Package
encukou Jun 8, 2022
521ad26
Move deprecated functions to a dedicated section, add modern equivalents
encukou Jun 8, 2022
719562b
Move replacements to the ..deprecated sections
encukou Jun 8, 2022
9bcca6b
Remove the link to migrating legacy usage: this is now documented here.
encukou Jun 8, 2022
ac007c3
Remove `errors` arguments from the migration snippets
encukou Jun 8, 2022
d1fefcb
Fix qualname of importlib.resources.abc.ResourceReader
encukou Jun 8, 2022
993ea9e
Reword the intro for deprecated functions
encukou Jun 8, 2022
77acd33
Remove unnecessary "headings"
encukou Jun 8, 2022
1fb51a0
Apply suggestions from code review
encukou Jun 9, 2022
a5a5377
Move classes that are actually in importlib.abc out from importlib.re…
encukou Jun 16, 2022
a03df1f
Fix references to classes in importlib.resources.abc
encukou Jun 16, 2022
85ad3c7
Merge remote-tracking branch 'upstream/main' into impres-docs
ambv Jul 25, 2022
fa68025
Slightly reword Package
ambv Jul 25, 2022
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
Prev Previous commit
Next Next commit
Shorten links to Traversable
  • Loading branch information
@encukou
encukou committed Jun 8, 2022
commit 02745153eaa6be42e0d54c096f716f8b60be4e64
4 changes: 2 additions & 2 deletions Doc/library/importlib.resources.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ The following functions are available.

.. function:: files(package)

Returns an :class:`importlib.resources.abc.Traversable` object
Returns an :class:`~importlib.resources.abc.Traversable` object
representing the resource container for the package (think directory)
and its resources (think files). A Traversable may contain other
containers (think subdirectories).
Expand All @@ -77,7 +77,7 @@ The following functions are available.

.. function:: as_file(traversable)

Given a :class:`importlib.resources.abc.Traversable` object representing
Given a :class:`~importlib.resources.abc.Traversable` object representing
a file, typically from :func:`importlib.resources.files`, return
a context manager for use in a :keyword:`with` statement.
The context manager provides a :class:`pathlib.Path` object.
Expand Down