-
Notifications
You must be signed in to change notification settings - Fork 26
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 the deprecated reciprocal lattice point class #213
Remove the deprecated reciprocal lattice point class #213
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@hakonanes Looks good. Some comments on adding extra infromation a couple of places while we are changing this code.
It might be worth adding information about the manifest and manifix to the developer guide if you think it is worth it but that can wait.
MANIFEST.in
Outdated
@@ -1,3 +1,5 @@ | |||
# https://setuptools.pypa.io/en/latest/userguide/miscellaneous.html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add a comment something along the lines of:
# For more information on managing files in pacakge
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The links now have a description.
diffsims/crystallography/get_hkl.py
Outdated
"""Return the highest Miller indices hkl of the plane with a direct | ||
space interplanar spacing greater than but closest to a lower | ||
threshold. | ||
|
||
Parameters |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"""Return the highest Miller indices hkl of the plane with a direct | |
space interplanar spacing greater than but closest to a lower | |
threshold. | |
Parameters | |
"""Return the highest Miller indices hkl of the plane with a direct | |
space interplanar spacing(d-spacing) greater than but closest to the ``min_dspacing``. | |
Parameters |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, I've added "(d-spacing)" and referred to the variable name (in italics instead of code-style, as used by NumPy).
20de09d
to
8268bdc
Compare
Add Deprecations Signed-off-by: Håkon Wiik Ånes <[email protected]>
…_hkl methods Signed-off-by: Håkon Wiik Ånes <[email protected]>
…ution Signed-off-by: Håkon Wiik Ånes <[email protected]>
Signed-off-by: Håkon Wiik Ånes <[email protected]>
Signed-off-by: Håkon Wiik Ånes <[email protected]>
Signed-off-by: Håkon Wiik Ånes <[email protected]>
ac91c00
to
d7b63b9
Compare
Signed-off-by: Håkon Wiik Ånes <[email protected]>
…ting guide Signed-off-by: Håkon Wiik Ånes <[email protected]>
I thought I'd resolved merge conflicts locally, but alas. I believe the issue relates to a small change you made in the reciprocal_lattice_point.py file, @CSSFrancis (6a7ac0b), which I here delete. I'll make a new branch and PR. |
I take that back, I don't really know what exactly caused the conflict (the addition of the deprecation decorators were e.g. taken as changes in this PR rather than coming from the main branch). |
Description of the change
Removes the deprecated
diffsims.crystallography.ReciprocalLatticePoint
class, which was deprecated in June 2022. Closes #189.Three methods in the public API for generating sets of {hkl} were not deprecated. These have improved replacements in the "new"
ReciprocalLatticeVector
class:get_hkl()
->from_highest_hkl()
get_highest_hkl()
->from_min_dspacing()
get_equivalent_hkl()
->symmetrise()
These functions should be deprecated and the user "new" methods. This can be done with the deprecation tools from #199, which should be merged before this PR.
Progress of the PR
For reviewers
__init__.py
.unreleased section in
CHANGELOG.rst
.credits
indiffsims/release_info.py
andin
.zenodo.json
.