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

Deprecate generators.VirtualBSEGenerator in favor of imaging.VirtualBSEImager #608

Merged
merged 10 commits into from
Feb 10, 2023

Conversation

hakonanes
Copy link
Member

Description of the change

kikuchipy.generators.VirtualBSEGenerator is deprecated in favor of kikuchipy.imaging.VirtualBSEImager. The deprecated class and the generators module will be removed in version 0.9.

Progress of the PR

Minimal example of the bug fix or new feature

>>> import kikuchipy as kp
>>> s = kp.data.nickel_ebsd_small()

# Before

>>> vbse_gen = kp.generators.VirtualBSEGenerator(s)

# Now
>>> vbse_imager = kp.imaging.VirtualBSEImager(s)

For reviewers

  • The PR title is short, concise, and will make sense 1 year later.
  • New functions are imported in corresponding __init__.py.
  • New features, API changes, and deprecations are mentioned in the unreleased
    section in CHANGELOG.rst.
  • New contributors are added to release.py, .zenodo.json and
    .all-contributorsrc with the table regenerated.

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes added the deprecation Deprecated functionality label Feb 10, 2023
@hakonanes hakonanes added this to the v0.8.0 milestone Feb 10, 2023
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
@hakonanes hakonanes merged commit 88945e2 into pyxem:develop Feb 10, 2023
@hakonanes hakonanes deleted the vbse-module branch February 10, 2023 22:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecation Deprecated functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove the kikuchipy.generators module, move functionality to where they belong
1 participant