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

Show file tree
Hide file tree
Changes from all 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
9 changes: 9 additions & 0 deletions doc/source/api/diffpy.utils.scattering_objects.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,12 @@ diffpy.utils.scattering_objects.diffraction_objects module
:members:
:undoc-members:
:show-inheritance:


diffpy.utils.scattering_objects.diffraction_object module
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.

API module created for DiffractionObject

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. automodule:: diffpy.utils.scattering_objects.diffraction_object
:members:
:undoc-members:
:show-inheritance:
23 changes: 23 additions & 0 deletions news/deprecate.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
**Added:**

* <news item>

**Changed:**

* <news item>

**Deprecated:**

* Diffraction_object class, renamed to DiffractionObject

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>
Loading