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

Remove deprecation - Axes, IO, Model #2998

Merged
merged 14 commits into from
Sep 7, 2022

Conversation

ericpre
Copy link
Member

@ericpre ericpre commented Aug 26, 2022

First round of deprecation removal.

Progress of the PR

  • axes.py,
  • io.py,
  • model.py,
  • update docstring (if appropriate),
  • update user guide (if appropriate),
  • add an changelog entry in the upcoming_changes folder (see upcoming_changes/README.rst),
  • Check formatting changelog entry in the readthedocs doc build of this PR (link in github checks)
  • update tests,
  • ready for review.

@codecov
Copy link

codecov bot commented Aug 26, 2022

Codecov Report

Merging #2998 (04fa987) into RELEASE_next_major (0c8a6aa) will increase coverage by 0.12%.
The diff coverage is 95.00%.

@@                  Coverage Diff                   @@
##           RELEASE_next_major    #2998      +/-   ##
======================================================
+ Coverage               80.29%   80.41%   +0.12%     
======================================================
  Files                     176      176              
  Lines                   24648    24586      -62     
  Branches                 5591     5577      -14     
======================================================
- Hits                    19790    19771      -19     
+ Misses                   3512     3479      -33     
+ Partials                 1346     1336      -10     
Impacted Files Coverage Δ
hyperspy/axes.py 91.01% <ø> (+0.20%) ⬆️
hyperspy/io.py 65.07% <ø> (+0.48%) ⬆️
hyperspy/misc/utils.py 90.31% <ø> (-0.05%) ⬇️
hyperspy/models/model1d.py 87.99% <ø> (ø)
hyperspy/signal.py 76.81% <ø> (+0.02%) ⬆️
hyperspy/model.py 86.70% <95.00%> (+2.99%) ⬆️

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

@ericpre ericpre changed the title Remove deprecation - part 1 Remove deprecation - Axes, IO, Model Aug 27, 2022
@ericpre ericpre mentioned this pull request Aug 27, 2022
57 tasks
CHANGES.rst Show resolved Hide resolved
CHANGES.rst Show resolved Hide resolved
CHANGES.rst Outdated Show resolved Hide resolved
CHANGES.rst Outdated Show resolved Hide resolved
@jlaehne
Copy link
Contributor

jlaehne commented Aug 29, 2022

I have seen in the RosettaSciIO deprecation PR that not always the changed terminology was properly documented in the user guide. So the documentation should be searched again for all deprecated names in the three deprecation PRs to make sure that there are no remnants of old terminology.

@ericpre
Copy link
Member Author

ericpre commented Aug 29, 2022

Yes, this should be done after we remove all deprecation?

@jlaehne
Copy link
Contributor

jlaehne commented Aug 30, 2022

Yes, this should be done after we remove all deprecation?

It could be done in each of the three branches for the respective keywords and functions by searching a local copy (as I did in hyperspy/rosettasciio#30). Otherwise, we should add a checkpoint to the todo list in #2996

@ericpre
Copy link
Member Author

ericpre commented Aug 31, 2022

As there are many deprecations, I made several PRs, so it is not too much pain to review, but the drawback of this approach is that, it is more difficult to find some left over which is why I suggested to do it later.

@jlaehne
Copy link
Contributor

jlaehne commented Aug 31, 2022

OK, I added to the todo list in #2996

@ericpre
Copy link
Member Author

ericpre commented Aug 31, 2022

Sorry, I missed the point that you were referring to the user guide!

@jlaehne
Copy link
Contributor

jlaehne commented Sep 7, 2022

I added a PR with some changes to the documentation.

@jlaehne jlaehne self-requested a review September 7, 2022 21:21
@jlaehne jlaehne merged commit ce93da7 into hyperspy:RELEASE_next_major Sep 7, 2022
@ericpre ericpre deleted the remove_deprecation branch September 8, 2022 06:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants