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.

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

Jump to bottom

Stabilize diffraction module #940

Closed
wants to merge 3 commits into from
Closed

Stabilize diffraction module #940

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
19cc1ae
remove instability notice
tommy-waltmann Apr 11, 2022
7fdddc8
add notice to changelog
tommy-waltmann Apr 11, 2022
a73bc68
Merge branch 'master' into doc/declare-diffraction-stable
tommy-waltmann Apr 12, 2022
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
3 changes: 3 additions & 0 deletions ChangeLog.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ and this project adheres to
### Added
* (breaking) Some `freud.diffraction.StaticStructureFactorDebye` property names changed to be more descriptive.

### Changed
* The API in the `freud.diffraction` module is now stable.

### Fixed
* `freud.diffraction.StaticStructureFactorDebye` implementation now gives `S_k[0] = N`.
* Cython is no longer listed as an install requirement in `setup.py`.
Expand Down
6 changes: 0 additions & 6 deletions freud/diffraction.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@
r"""
The :class:`freud.diffraction` module provides functions for computing the
diffraction pattern of particles in systems with long range order.

.. rubric:: Stability

:mod:`freud.diffraction` is **unstable**. When upgrading from version 2.x to
2.y (y > x), existing freud scripts may need to be updated. The API will be
finalized in a future release.
"""

from libcpp cimport bool as cbool
Expand Down