Repository navigation
Deprecate unused introspection functions - #15934
Merged
Merged
Conversation
The function is not used anywhere in `astropy`.
The function is not used anywhere in `astropy`.
eerovaher
added
utils
API change
Contributor
|
Thank you for your contribution to Astropy! 🌌 This checklist is meant to remind the package maintainers who will review this pull request of some common things to look for.
|
pllim
approved these changes
Jan 23, 2024
pllim
left a comment
pllim
left a comment
Member
There was a problem hiding this comment.
Seems reasonable. Thanks for the clean-up!
Let's get this in earlier than later so downstream has a chance to catch this if they somehow using these.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
astropy.utils.introspection.isinstancemethod()isn't used anywhere (since 9bbdd64) and should be safe to remove without replacement. Previously the function simply called a private function that contained the actual implementation. I have removed the private function to ensure that it doesn't stay in the code when the public function gets removed. I have also removed examples from the function docstring to avoid having to deal with deprecation warnings there.astropy.utils.introspection.find_mod_objs()was used for automatically generating API listings for Sphinx, but that functionality has since been moved fromastropyto a dedicatedsphinx-automodapipackage that has its ownfind_mod_objs(): https://github.com/astropy/sphinx-automodapi/blob/7c57ce13320e8b0448e75e4d8300748a914fa2cb/sphinx_automodapi/utils.py#L40. The implementation inastropyis no longer used anywhere and should be safe to remove without replacement.