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

Expedite removal convention parameter in from/to_euler() methods #446

Merged
merged 4 commits into from
Apr 23, 2023

Conversation

hakonanes
Copy link
Member

@hakonanes hakonanes commented Apr 22, 2023

Description of the change

This PR changes the planned removal of the convention parameter in the class methods to convert between quaternions and Euler angles to v0.13, in two minor releases. The original plan was to remove it in v1.0, but there are many kinks left to iron out before that, so I suggest to remove it in v0.13 as it was deprecated since v0.9.

I've made some other minor changes to wording and simplified some code in the docs as well.

These changes were originally added in for #442, but since that PR has to wait, I've made this PR instead.

Progress of the PR

Minimal example of the bug fix or new feature

See the docs built from this PR: https://orix--446.org.readthedocs.build/en/446/changelog.html.

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.
  • Contributor(s) are listed correctly in __credits__ in orix/__init__.py and in
    .zenodo.json.

@hakonanes hakonanes added documentation Relates to the documentation deprecation Deprecated functionality labels Apr 22, 2023
@hakonanes hakonanes added this to the v0.12.0 milestone Apr 22, 2023
@hakonanes hakonanes force-pushed the expediate-removal-convention-parameter branch from 5ea3aa5 to 6d9a527 Compare April 22, 2023 15:21
@hakonanes hakonanes requested review from pc494 and harripj April 22, 2023 15:24
@hakonanes hakonanes force-pushed the expediate-removal-convention-parameter branch from 6d9a527 to 6416323 Compare April 22, 2023 18:06
Copy link
Member

@pc494 pc494 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

100% agree, and the change looks correctly implemented, merging.

@pc494 pc494 merged commit dfba8aa into pyxem:develop Apr 23, 2023
@hakonanes hakonanes deleted the expediate-removal-convention-parameter branch November 3, 2023 15:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deprecation Deprecated functionality documentation Relates to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants