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

Use deprecation package #9

Open
mdbenito opened this issue Feb 26, 2023 · 2 comments
Open

Use deprecation package #9

mdbenito opened this issue Feb 26, 2023 · 2 comments
Labels
enhancement New feature or request

Comments

@mdbenito
Copy link
Member

Make it a dependency, and check in the release script that no deprecated methods are left behind in a release. deprecation allows marking the moment something is tagged for deprecation and the release at which it will be removed, e.g.

@deprecated(
    deprecated_in="0.6.0",
    removed_in="0.7.0",
    details="This class has been renamed. Use StandardErrorRatio instead",
)
class StandardError(StandardErrorRatio):
    pass
@mdbenito mdbenito added the enhancement New feature or request label Feb 26, 2023
@MischaPanch
Copy link
Collaborator

I don't think this needs to be part of a template. Users can add it themselves if they want to, right?

@mdbenito
Copy link
Member Author

mdbenito commented Apr 2, 2024

Maybe you are right. My reasoning was that if pymetrius is for libraries, then every instantiation of pymetrius will need this package because careful deprecation is a must for every library. It took me a while to realize that the other only alternative, pydeprecate, was not good enough (for reasons I have already forgotten), so I thought it might save others some time to know about it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants