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

Add DeprecationWarnings to several old functions #200

Merged
merged 1 commit into from
Nov 15, 2022

Conversation

freemansw1
Copy link
Member

This PR is simply to add several DeprecationWarnings to various functions that have been discussed before as needing to be removed or substantially reworked for v2.0. Getting these DeprecationWarnings into v1.5 should give users enough time to migrate away from the functions.

Resolves #198 and #158.

  • Have you followed our guidelines in CONTRIBUTING.md?
  • Have you self-reviewed your code and corrected any misspellings?
  • Have you written documentation that is easy to understand?
  • Have you written descriptive commit messages?
  • Have you added NumPy docstrings for newly added functions?
  • Have you formatted your code using black?
  • If you have introduced a new functionality, have you added adequate unit tests?
  • Have all tests passed in your local clone?
  • If you have introduced a new functionality, have you added an example notebook?
  • Have you kept your pull request small and limited so that it is easy to review?
  • Have the newest changes from this branch been merged?

@codecov
Copy link

codecov bot commented Nov 14, 2022

Codecov Report

Base: 35.06% // Head: 34.89% // Decreases project coverage by -0.17% ⚠️

Coverage data is based on head (44b9dd5) compared to base (dfe3b38).
Patch coverage: 12.50% of modified lines in pull request are covered.

Additional details and impacted files
@@              Coverage Diff              @@
##           RC_v1.5.0     #200      +/-   ##
=============================================
- Coverage      35.06%   34.89%   -0.18%     
=============================================
  Files             10       10              
  Lines           2099     2115      +16     
=============================================
+ Hits             736      738       +2     
- Misses          1363     1377      +14     
Flag Coverage Δ
unittests 34.89% <12.50%> (-0.18%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
tobac/plotting.py 3.05% <0.00%> (-0.04%) ⬇️
tobac/centerofgravity.py 7.05% <20.00%> (+0.80%) ⬆️
tobac/wrapper.py 8.06% <33.33%> (+1.28%) ⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@freemansw1 freemansw1 added this to the Version 1.5 milestone Nov 15, 2022
Copy link
Collaborator

@snilsn snilsn left a comment

Choose a reason for hiding this comment

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

Nice work @freemansw1. After my experience with these functions I think that this step is the right way to go.

Copy link
Member

@JuliaKukulies JuliaKukulies left a comment

Choose a reason for hiding this comment

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

Perfect, that makes sense @freemansw1. Thanks for your changes! Is there any clever way we can go about the coverage in pull requests like this or are we just ignoring it because we know we only added warnings?

@freemansw1
Copy link
Member Author

freemansw1 commented Nov 15, 2022

@JuliaKukulies we have changed the code coverage threshold to -1% in #183, but I don't know that those changes have been merged back into v1.5.0 yet.

@freemansw1 freemansw1 merged commit 094dda7 into tobac-project:RC_v1.5.0 Nov 15, 2022
@freemansw1
Copy link
Member Author

Thanks for the quick reviews!

@JuliaKukulies
Copy link
Member

@JuliaKukulies we have changed the code coverage threshold to -1% in #183, but I don't know that those changes have been merged back into v1.5.0 yet.

Right, sorry! I was aware of the change with #183 but misread and thought this would be even more than -1 %. There are probably a few things that haven't merged back yet, but I guess this will be done directly after the release so never mind

@freemansw1
Copy link
Member Author

Yeah, now that we're so close to 1.4.0, I'm planning to wait to merge 1.4.0 into 1.5.0 until release.

@freemansw1 freemansw1 mentioned this pull request Nov 21, 2022
11 tasks
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