Skip to content

Deprecate Diffraction_object, rename to DiffractionObject #165

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.

Sign up for GitHub

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

Closed
wants to merge 12 commits into from
Closed

Deprecate Diffraction_object, rename to DiffractionObject #165

Changes from 2 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
25a089e
Diffraction_object deprecation warning
bobleesj Nov 9, 2024
558cc1e
apply pre-commit
bobleesj Nov 9, 2024
6e9b465
Include the word deprecated in the warning msg
bobleesj Nov 10, 2024
2b0b112
Create a new object named DiffractionObject
bobleesj Nov 10, 2024
0161a8b
Add news and a new test file for DiffractionObject
bobleesj Nov 10, 2024
da60a89
[pre-commit.ci] auto fixes from pre-commit hooks
pre-commit-ci[bot] Nov 10, 2024
71c9f99
Remove the unused warnings in DiffractionObject
bobleesj Nov 10, 2024
dca3e23
:wq
bobleesj Nov 10, 2024
86838de
Remove methods in docstring
bobleesj Nov 10, 2024
7c73140
Apply pre-commit
bobleesj Nov 10, 2024
16b8bbe
Add The in front of each parameter description in docstring
bobleesj Nov 13, 2024
ca872c0
Add linear to linearly spaced...
bobleesj Nov 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions src/diffpy/utils/scattering_objects/diffraction_objects.py
View file
Open in desktop
Copy link
Contributor Author

@bobleesj bobleesj Nov 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Two deprecation messages written 1) docstring level 2) class level

Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import datetime
import warnings
from copy import deepcopy

import numpy as np
Expand All @@ -18,6 +19,20 @@


class Diffraction_object:
"""FIXME: Add class docstring.
.. deprecated:: 3.5.1
Copy link
Contributor Author

@bobleesj bobleesj Nov 9, 2024

Choose a reason for hiding this comment

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

Following the numpy deprecation standards:

Screenshot 2024-11-09 at 12 28 11 PM

Ref: https://numpydoc.readthedocs.io/en/latest/format.html#deprecation-warning

`Diffraction_object` will be removed in diffpy.utils 3.6.0, it is replaced by
`DiffractionObject` to follow the class naming convention.
"""

warnings.warn(
Copy link
Contributor Author

@bobleesj bobleesj Nov 9, 2024

Choose a reason for hiding this comment

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

Warning produced at the run-time level:

Screenshot 2024-11-09 at 12 29 11 PM

Copy link
Contributor

@sbillinge sbillinge Nov 10, 2024

Choose a reason for hiding this comment

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

This looks good. Here I would maybe begin with the words "Diffraction_object is deprecated and will be removed....."

Copy link
Contributor Author

@bobleesj bobleesj Nov 10, 2024

Choose a reason for hiding this comment

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

Fixed

"Diffraction_object` will be removed in diffpy.utils 3.6.0, it is replaced by "
"DiffractionObject` to follow the class naming convention.",
DeprecationWarning,
stacklevel=2,
)

def __init__(self, name="", wavelength=None):
self.name = name
self.wavelength = wavelength
Expand Down
Loading