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

anesthetic 2 deprecation cleanup #320

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

williamjameshandley
Copy link
Collaborator

Description

This PR can be merged when we are happy to deprecate the guardrails for users still transferring from anesthetic 1.

Checklist:

  • I have performed a self-review of my own code
  • My code is PEP8 compliant (flake8 anesthetic tests)
  • My code contains compliant docstrings (pydocstyle --convention=numpy anesthetic)
  • New and existing unit tests pass locally with my changes (python -m pytest)
  • I have added tests that prove my fix is effective or that my feature works
  • I have appropriately incremented the semantic version number in both README.rst and anesthetic/_version.py

@codecov
Copy link

codecov bot commented Jul 25, 2023

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (1bddc80) 100.00% compared to head (a401ba9) 100.00%.

Additional details and impacted files
@@            Coverage Diff            @@
##            master      #320   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           34        34           
  Lines         2858      2820   -38     
=========================================
- Hits          2858      2820   -38     
Files Changed Coverage Δ
anesthetic/plot.py 100.00% <ø> (ø)
anesthetic/plotting/_core.py 100.00% <ø> (ø)
anesthetic/samples.py 100.00% <ø> (ø)
anesthetic/utils.py 100.00% <ø> (ø)
anesthetic/_version.py 100.00% <100.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@lukashergt
Copy link
Collaborator

In light of the rather fast incrementing version number, I'd suggest giving it some more time...
Maybe ~o(3months) from 2.0.0 release?

@williamjameshandley
Copy link
Collaborator Author

In light of the rather fast incrementing version number, I'd suggest giving it some more time... Maybe ~o(3months) from 2.0.0 release?

Agreed * sets reminder *

"\'hist_1d\' and \'hist_2d\' are the appropriate "
"keywords for anesthetic. Your plots may look "
"odd if you use this argument."
)
Copy link
Collaborator

Choose a reason for hiding this comment

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

I don't understand why these warnings should be removed?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Agreed, these will actually still be useful for new users of anesthetic. This is different from warnings that are about changes from anesthetic 1 to anesthetic 2.

So, yes, I think we should keep them, but then they should become part of the tests. Let's address this in #342.

"\'hist_1d\' and \'hist_2d\' are the appropriate "
"keywords for anesthetic. Your plots may look "
"odd if you use this argument."
)
Copy link
Collaborator

Choose a reason for hiding this comment

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

Agreed, these will actually still be useful for new users of anesthetic. This is different from warnings that are about changes from anesthetic 1 to anesthetic 2.

So, yes, I think we should keep them, but then they should become part of the tests. Let's address this in #342.

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

Successfully merging this pull request may close these issues.

3 participants