From 19cc1ae7a3700b052129fc3edf4edf8cda9b71fa Mon Sep 17 00:00:00 2001 From: Tommy Waltmann Date: Mon, 11 Apr 2022 15:40:07 -0400 Subject: [PATCH 1/2] remove instability notice --- freud/diffraction.pyx | 6 ------ 1 file changed, 6 deletions(-) diff --git a/freud/diffraction.pyx b/freud/diffraction.pyx index 2a2b48e3c..4d8bfe6d3 100644 --- a/freud/diffraction.pyx +++ b/freud/diffraction.pyx @@ -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 From 7fdddc89a2f7f8e22d825d64f6ceecf7727b5670 Mon Sep 17 00:00:00 2001 From: Tommy Waltmann Date: Mon, 11 Apr 2022 15:47:02 -0400 Subject: [PATCH 2/2] add notice to changelog --- ChangeLog.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/ChangeLog.md b/ChangeLog.md index efcc20b4b..bad5a46f0 100644 --- a/ChangeLog.md +++ b/ChangeLog.md @@ -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`.