pyxem icon indicating copy to clipboard operation
pyxem copied to clipboard

Published 20 hours ago • verified publisher icon pyxem

Deprecation

Open CSSFrancis opened this issue 2 years ago • 1 comments

Name: Adding in a Deprecation wrapper About: This copies some of how kikuchipy does their deprecation (Which copies matplotlib and nump)

Checklist

  • [x] Updated CHANGELOG.md
  • [x] Added in deprecate decorator
  • [x] Added in tests for deprecation
  • [x] Added deprecation for known functions in Diffraction2D
  • [x] Added deprecation for known Generators

What does this PR do? Please describe and/or link to an open issue. I think this is a good start for 0.15. We can start to deprecate functions as they are changed before 1.0 and then remove them after that.

Describe alternatives you've considered I think that we could also increase the amount of info/warnings that are output. That could be a separate PR

Are there any known issues? Do you need help? @hakonanes Let me know if you have any other ideas etc.

CSSFrancis avatar Aug 10 '22 19:08 CSSFrancis

running black should solve the conflicts here.

pc494 avatar Aug 13 '22 12:08 pc494

Coverage Status

Coverage increased (+0.07%) to 96.009% when pulling 5b7c23a589395ef0d6ba1964de5d0597716713ae on CSSFrancis:Deprecation into e9333ff18654f9263261b8dc2a8da587a0ef2e66 on pyxem:master.

coveralls avatar Nov 07 '22 19:11 coveralls

Feel free to merge yourself.

hakonanes avatar Nov 10 '22 16:11 hakonanes

Looks good. Let's hope these decorators help us streamline the API in the future!

Hopefully :) Now I have to start cutting out some code.

CSSFrancis avatar Nov 10 '22 22:11 CSSFrancis