Skip to content
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.

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

gh-105189: fix importlib.resources.abc deprecation docs #105232

Merged

Conversation

graingert
Copy link
Contributor

@graingert graingert commented Jun 2, 2023

@graingert
Copy link
Contributor Author

what to do about importlib.resources.abc.ResourceReader it seems it's supposed to be deprecated, but there's no deprecation warning in the source code

@graingert
Copy link
Contributor Author

@graingert graingert marked this pull request as ready for review June 2, 2023 10:26
@graingert
Copy link
Contributor Author

the versionadded entries are incorrect on the 3.11 doc pages https://docs.python.org/3.11/library/importlib.resources.abc.html#importlib.resources.abc.TraversableResources

Doc/library/importlib.resources.abc.rst Outdated Show resolved Hide resolved
Doc/library/importlib.rst Outdated Show resolved Hide resolved
Doc/library/importlib.rst Outdated Show resolved Hide resolved
Doc/library/importlib.rst Outdated Show resolved Hide resolved
Doc/library/importlib.rst Outdated Show resolved Hide resolved
Doc/library/importlib.rst Outdated Show resolved Hide resolved
Doc/library/importlib.rst Outdated Show resolved Hide resolved
Doc/library/importlib.rst Outdated Show resolved Hide resolved
@brettcannon brettcannon requested review from jaraco and removed request for brettcannon June 9, 2023 22:47
Copy link
Member

@serhiy-storchaka serhiy-storchaka left a comment

Choose a reason for hiding this comment

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

Concur with @graingert that separate versionadded directive for classes are not needed if they duplicate the module level versionadded.

I think that rather than duplicating documentation in importlib.rst (it can became de-synchronized), it would be enough to add minimal class declarations followed by references to new classes.

@hugovk
Copy link
Member

hugovk commented Sep 12, 2023

@graingert Would be great to get this ready for 3.12.0 final in a couple of weeks. Thanks!

@graingert graingert requested a review from hugovk September 12, 2023 20:43
Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Thank you!

@hugovk hugovk added the needs backport to 3.12 bug and security fixes label Sep 13, 2023
@hugovk hugovk merged commit 6c0ddca into python:main Sep 13, 2023
@miss-islington
Copy link
Contributor

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Sep 13, 2023
…GH-105232)

(cherry picked from commit 6c0ddca)

Co-authored-by: Thomas Grainger <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Alex Waygood <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Sep 13, 2023

GH-109363 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 bug and security fixes label Sep 13, 2023
@hugovk
Copy link
Member

hugovk commented Sep 13, 2023

the versionadded entries are incorrect on the 3.11 doc pages https://docs.python.org/3.11/library/importlib.resources.abc.html#importlib.resources.abc.TraversableResources

Do we need a separate PR to fix this bit in 3.11?

@graingert graingert deleted the fix-importlib-resources-abc-deprecations branch September 13, 2023 09:14
@graingert
Copy link
Contributor Author

@hugovk yeah I think so

Yhg1s pushed a commit that referenced this pull request Sep 13, 2023
…5232) (#109363)

gh-105189: fix importlib.resources.abc deprecation docs (GH-105232)
(cherry picked from commit 6c0ddca)

Co-authored-by: Thomas Grainger <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
Co-authored-by: Alex Waygood <[email protected]>
vstinner pushed a commit to vstinner/cpython that referenced this pull request Sep 13, 2023
@hugovk
Copy link
Member

hugovk commented Sep 13, 2023

@graingert Would you like to do the honours? :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants