Skip to content

Navigation Menu

Sign in
Appearance settings

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

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

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

Merged
ambv merged 18 commits into
python:mainpython/cpython:mainfrom
encukou:impres-docsencukou/cpython:impres-docsCopy head branch name to clipboard
Jul 25, 2022
Merged

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

Conversation

@encukou

@encukou encukou 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 added 13 commits June 8, 2022 19:14
@encukou encukou requested a review from jaraco June 8, 2022 17:27
@bedevere-bot bedevere-bot added docs Documentation in the Doc dir awaiting core review labels Jun 8, 2022
@encukou encukou mentioned this pull request Jun 8, 2022
Closed
slateny
slateny reviewed Jun 9, 2022
View reviewed changes
Comment thread Doc/library/importlib.resources.rst Outdated
AA-Turner
AA-Turner reviewed Jun 9, 2022
View reviewed changes

@AA-Turner AA-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 thread Doc/library/importlib.resources.abc.rst Outdated
Comment thread Doc/library/importlib.resources.rst Outdated
Comment thread Doc/library/importlib.resources.rst
Comment thread Doc/library/importlib.resources.rst Outdated
Comment thread Doc/library/importlib.resources.rst Outdated
Comment thread Doc/library/importlib.resources.rst
Comment thread Doc/library/importlib.resources.rst
Comment thread Doc/library/importlib.resources.rst
Comment thread Doc/library/importlib.resources.rst Outdated
Comment thread Doc/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
Member Author

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
Member Author

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

@warsaw warsaw mentioned this pull request Jul 4, 2022
Merged
@ambv ambv added the needs backport to 3.11 only security fixes label Jul 25, 2022
@ambv ambv merged commit ccd7c7a into python:main Jul 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-bot bedevere-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 free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@slateny slateny slateny left review comments
@AA-Turner AA-Turner AA-Turner approved these changes
@jaraco jaraco Awaiting requested review from jaraco jaraco is a code owner

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news topic-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
Morty Proxy This is a proxified and sanitized view of the page, visit original site.