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

Merged

ambv merged 18 commits into

python:mainfrom

encukou:impres-docs

Jul 25, 2022

Commits on Jun 8, 2022

Add a concrete example of why you'd use importlib.resources over Path(__file__)
encukou
committed
6a97526
Copy full SHA for 6a97526
Link to the definition of a new term
encukou
committed
77b50ae
Copy full SHA for 77b50ae
Add importlib.resources.abc docs to the hierarchy, to fix links
encukou
committed
89f00a2
Copy full SHA for 89f00a2
Package: Document what this is first, then give the formal definition
encukou
committed
9134901
Copy full SHA for 9134901
Shorten links to Traversable
encukou
committed
0274515
Copy full SHA for 0274515
Link to Package
encukou
committed
39ab32a
Copy full SHA for 39ab32a
Move deprecated functions to a dedicated section, add modern equivalents
encukou
committed
521ad26
Copy full SHA for 521ad26
Move replacements to the ..deprecated sections
encukou
committed
719562b
Copy full SHA for 719562b
Remove the link to migrating legacy usage: this is now documented here.
encukou
committed
9bcca6b
Copy full SHA for 9bcca6b
Remove `errors` arguments from the migration snippets
encukou
committed
ac007c3
Copy full SHA for ac007c3
Fix qualname of importlib.resources.abc.ResourceReader
encukou
committed
d1fefcb
Copy full SHA for d1fefcb
Reword the intro for deprecated functions
encukou
committed
993ea9e
Copy full SHA for 993ea9e
Remove unnecessary "headings"
encukou
committed
77acd33
Copy full SHA for 77acd33

Commits on Jun 9, 2022

Apply suggestions from code review
Show description for 1fb51a0

authored
1fb51a0
Copy full SHA for 1fb51a0

Commits on Jun 16, 2022

Move classes that are actually in importlib.abc out from importlib.resources.abc
encukou
committed
a5a5377
Copy full SHA for a5a5377
Fix references to classes in importlib.resources.abc
encukou
committed
a03df1f
Copy full SHA for a03df1f

Commits on Jul 25, 2022

Merge remote-tracking branch 'upstream/main' into impres-docs
ambv
committed
85ad3c7
Copy full SHA for 85ad3c7
Slightly reword Package
ambv
committed
fa68025
Copy full SHA for fa68025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

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

gh-93610: Improve docs for importlib.resources#93611
ambv merged 18 commits into
python:mainpython/cpython:mainfrom
encukou:impres-docsencukou/cpython:impres-docsCopy head branch name to clipboard

Commits on Jun 8, 2022

Add a concrete example of why you'd use importlib.resources over Path(file)

Link to the definition of a new term

Add importlib.resources.abc docs to the hierarchy, to fix links

Package: Document what this is first, then give the formal definition

Shorten links to Traversable

Link to Package

Move deprecated functions to a dedicated section, add modern equivalents

Move replacements to the ..deprecated sections

Remove the link to migrating legacy usage: this is now documented here.

Remove `errors` arguments from the migration snippets

Fix qualname of importlib.resources.abc.ResourceReader

Reword the intro for deprecated functions

Remove unnecessary "headings"

Commits on Jun 9, 2022

Apply suggestions from code review

Commits on Jun 16, 2022

Move classes that are actually in importlib.abc out from importlib.resources.abc

Fix references to classes in importlib.resources.abc

Commits on Jul 25, 2022

Merge remote-tracking branch 'upstream/main' into impres-docs

Slightly reword Package

Search code, repositories, users, issues, pull requests...

Uh oh!

Uh oh!

Commits

Commits on Jun 8, 2022

Commits on Jun 9, 2022

Commits on Jun 16, 2022

Commits on Jul 25, 2022