Skip to content

Possible typo in the documentation of importlib.resources.abc #99795

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

Jump to bottom
Closed
busywhitespace opened this issue Nov 26, 2022 · 1 comment
Closed

Possible typo in the documentation of importlib.resources.abc #99795

busywhitespace opened this issue Nov 26, 2022 · 1 comment
Assignees
@jaraco
Labels
docs Documentation in the Doc dir

Comments

@busywhitespace
Copy link
Contributor

busywhitespace commented Nov 26, 2022 •
edited by bedevere-bot
Loading

The documentation for importlib.resources.abc.TraversableResources at the end of the importlib.resources.abc documentation says:

... Therefore, any loader supplying importlib.abc.TraversableReader also supplies ResourceReader.

But importlib.abc.TraversableReader isn't exposed in the module. In my opinion, the author of the documentation meant TraversableResources considering the fact, that the preceding sentence talks about TraversableResources subclassing ResourceReader.

Subclasses importlib.resources.abc.ResourceReader and provides concrete implementations of the importlib.resources.abc.ResourceReader’s abstract methods

I've created the PR in case the issue is correct.

Linked PRs
@busywhitespace busywhitespace added the docs Documentation in the Doc dir label Nov 26, 2022
@busywhitespace busywhitespace mentioned this issue Nov 26, 2022
Merged
@jaraco jaraco self-assigned this Nov 26, 2022
@jaraco
Copy link
Member

jaraco commented Nov 26, 2022

My initial instinct was that TraversableReader was intended here, but after reading it over several times, I agree with your assessment.

miss-islington pushed a commit that referenced this issue Nov 26, 2022
@busywhitespace
gh-99795: Fix typo in importlib.resources.abc (GH-99796)
5f88982 
Changing TraversableReader to TraversableResources at one place of the documentation.

See #99795 for more details.
@miss-islington miss-islington mentioned this issue Nov 26, 2022
Merged
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Nov 26, 2022
@busywhitespace @miss-islington
pythongh-99795: Fix typo in importlib.resources.abc (pythonGH-99796)
cd6d84e 
Changing TraversableReader to TraversableResources at one place of the documentation.

See pythonGH-99795 for more details.
(cherry picked from commit 5f88982)

Co-authored-by: busywhitespace <[email protected]>
miss-islington added a commit that referenced this issue Nov 26, 2022
@miss-islington @busywhitespace
gh-99795: Fix typo in importlib.resources.abc (GH-99796)
fe99572 
Changing TraversableReader to TraversableResources at one place of the documentation.

See GH-99795 for more details.
(cherry picked from commit 5f88982)

Co-authored-by: busywhitespace <[email protected]>
@jaraco jaraco mentioned this issue Nov 26, 2022
Merged
jaraco added a commit that referenced this issue Nov 26, 2022
@jaraco @busywhitespace
[3.10] gh-99795: Fix typo in importlib.resources.abc (GH-99796) (GH-9…
3d82b7e 
…9800)

Changing TraversableReader to TraversableResources at one place of the documentation.

See GH-99795 for more details..
(cherry picked from commit 5f88982)

Co-authored-by: busywhitespace <[email protected]>

Co-authored-by: busywhitespace <[email protected]>
@jaraco jaraco closed this as completed Nov 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jaraco jaraco

Labels
docs Documentation in the Doc dir
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jaraco @busywhitespace