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 deprecation warning to resample function #180

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

alisnwu
Copy link

@alisnwu alisnwu commented Nov 24, 2024

closes #139

Only adding a deprecation warning as per discussion with @Sparks29032 in #145

Warning looks like this:
Screenshot 2024-11-23 at 11 27 53 PM

@sbillinge ready for review

Copy link

codecov bot commented Nov 24, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.56%. Comparing base (b31135d) to head (af7ffd4).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #180   +/-   ##
=======================================
  Coverage   99.56%   99.56%           
=======================================
  Files           7        7           
  Lines         230      230           
=======================================
  Hits          229      229           
  Misses          1        1           
---- 🚨 Try these New Features:

@Sparks29032
Copy link
Collaborator

Sparks29032 commented Nov 24, 2024

We could also consider using @deprecated per https://typing.readthedocs.io/en/latest/spec/directives.html#deprecated

I think we should also phase the message in a way that indicates why we are deprecating: resample has been renamed wsinterp to better reflect functionalty smth smth

@sbillinge
Copy link
Contributor

Yes, I agree with @Sparks29032 . Also please specify the future version where it will be removed. Normally two mid-level version bumps later.

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.

deprecate legacy resampler?
3 participants