add deprecation warning to resample function

[alisnwu]

closes #139

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

Warning looks like this:

@sbillinge ready for review

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.97%. Comparing base (b31135d) to head (02a2c70).
Report is 36 commits behind head on main.

❗ There is a different number of reports uploaded between BASE (b31135d) and HEAD (02a2c70). Click for more details.

HEAD has 14 uploads less than BASE

Flag	BASE (b31135d)	HEAD (02a2c70)
	15	1

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #180      +/-   ##
==========================================
- Coverage   99.56%   93.97%   -5.59%     
==========================================
  Files           7        8       +1     
  Lines         230      299      +69     
==========================================
+ Hits          229      281      +52     
- Misses          1       18      +17     

see 13 files with indirect coverage changes

[Sparks29032]

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]

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

[bobleesj]

This is good. Does this decorator also work in Python 3.12 and 3.11 without failing the test?

[alisnwu]

I'll test on that and make a new PR based on the new structure

[alisnwu]

@bobleesj this deprecated decorator actually is only released for 3.13 so should I use warnings.warn instead? @Sparks29032

[bobleesj]

Yes, it's a new feature for 3.13.

If it doesn't work for 3.11 and 3.12, then I suggest we should not use this decorator since then 3.11 and 3.12 users won't be able to read this warning msg. tagging @sbillinge for his opinion too.

[bobleesj]

Also, since this is a public facing PR, why is it being closed?

[alisnwu]

@bobleesj I wanted to make a new PR since this was before the major reconstruction simon made

[bobleesj]

@alisnwu If it doesn't work, then we can use https://numpydoc.readthedocs.io/en/latest/format.html#deprecation-warning