Skip to content

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

Merged
ambv merged 18 commits into
python:mainfrom
encukou:impres-docs
Jul 25, 2022
Merged

gh-93610: Improve docs for importlib.resources#93611
ambv merged 18 commits into
python:mainfrom
encukou:impres-docs

Conversation

@encukou

@encukouencukou commented Jun 8, 2022•
edited by bedevere-bot
Loading

Copy link
Copy Markdown
Member

This PR aims to make importlib.resources docs more usable.
@jaraco, do these look reasonable?

Please, if you have suggestions for more improvements, use the issue (or another PR). This PR does not aim to make the docs perfect, just better.

@encukou
encukou requested a review from jaracoJune 8, 2022 17:27
@bedevere-botbedevere-bot added docs Documentation in the Doc dir awaiting core review labels Jun 8, 2022
@encukouencukou mentioned this pull request Jun 8, 2022
Closed
slateny
slateny reviewed Jun 9, 2022
View reviewed changes
Comment threadDoc/library/importlib.resources.rst Outdated
AA-Turner
AA-Turner reviewed Jun 9, 2022
View reviewed changes

@AA-TurnerAA-Turner left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nothing major:

A

Comment threadDoc/library/importlib.resources.abc.rst Outdated
Comment threadDoc/library/importlib.resources.rst Outdated
Comment threadDoc/library/importlib.resources.rst
Comment threadDoc/library/importlib.resources.rst Outdated
Comment threadDoc/library/importlib.resources.rst Outdated
Comment threadDoc/library/importlib.resources.rst
Comment threadDoc/library/importlib.resources.rst
Comment threadDoc/library/importlib.resources.rst
Comment threadDoc/library/importlib.resources.rst Outdated
Comment threadDoc/library/importlib.resources.rst
@encukou@AA-Turner@slateny
Apply suggestions from code review
1fb51a0
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
@encukou

encukou commented Jun 16, 2022

Copy link
Copy Markdown
MemberAuthor

Hm, I see the mistake I made here: I moved all of importlib.abc to a new file, but in reality that page should be split between importlib.abc and importlib.resources.abc.
One day I'll learn how this package works, but it's not today!

@encukou

encukou commented Jun 16, 2022

Copy link
Copy Markdown
MemberAuthor

Here's a fix.
There's a remaining reference to a importlib.abc.TraversableReader, which is undocumented and actually lives in the undocumented module importlib.resources.simple, but declare that out of scope of this PR.

@AA-Turner

AA-Turner commented Jun 16, 2022

Copy link
Copy Markdown
Member

It might make sense to break out importlib.abc to its own page, but out of scope for this importlib.resouces-specific PR.

A

@warsawwarsaw mentioned this pull request Jul 4, 2022
Merged
@ambvambv added the needs backport to 3.11 only security fixes label Jul 25, 2022
@ambv
ambv merged commit ccd7c7a into python:mainJul 25, 2022
@miss-islington

miss-islington commented Jul 25, 2022

Copy link
Copy Markdown
Contributor

Thanks @encukou for the PR, and @ambv for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11.
🐍🍒⛏🤖

@bedevere-botbedevere-bot removed the needs backport to 3.11 only security fixes label Jul 25, 2022
@bedevere-bot

bedevere-bot commented Jul 25, 2022

Copy link
Copy Markdown

GH-95247 is a backport of this pull request to the 3.11 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 25, 2022
@encukou@miss-islington
pythongh-93610: Improve docs for importlib.resources (pythonGH-93611)
f448394
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit ccd7c7a)
Co-authored-by: Petr Viktorin <encukou@gmail.com>
ambv added a commit that referenced this pull request Jul 25, 2022
@miss-islington@encukou
@AA-Turner@slateny@ambv
gh-93610: Improve docs for importlib.resources (GH-93611) (GH-95247)
9217051
(cherry picked from commit ccd7c7a)
Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@slatenyslatenyslateny left review comments
@AA-TurnerAA-TurnerAA-Turner approved these changes
@jaracojaracoAwaiting requested review from jaracojaraco is a code owner

Assignees

No one assigned

Labels

docsDocumentation in the Doc dirskip newstopic-importlib

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@encukou@AA-Turner@miss-islington@bedevere-bot@slateny@ambv