-
-
Notifications
You must be signed in to change notification settings - Fork 32.1k
gh-105189: fix importlib.resources.abc deprecation docs #105232
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
Conversation
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 |
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 |
There was a problem hiding this 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.
@graingert Would be great to get this ready for 3.12.0 final in a couple of weeks. Thanks! |
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you!
Thanks @graingert for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12. |
…GH-105232) (cherry picked from commit 6c0ddca) Co-authored-by: Thomas Grainger <tagrain@gmail.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
GH-109363 is a backport of this pull request to the 3.12 branch. |
Do we need a separate PR to fix this bit in 3.11? |
@hugovk yeah I think so |
1�7#105232) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@graingert Would you like to do the honours? :) |
importlib.resources.abc.TraversableResources
says it is deprecated in favour of itself #105189📚 Documentation preview 📚: https://cpython-previews--105232.org.readthedocs.build/