From dcca1fc8a170beef0283fb5f26617f1db73d39be Mon Sep 17 00:00:00 2001 From: Caden Myers Date: Thu, 29 Oct 2026 17:33:11 -0400 Subject: [PATCH] refactor: rename profiles module to peak_profiles Avoid confusion with srfit's Profile. Renames profiles.py and test_profiles.py and updates the API docs. The module is unreleased, so no deprecation shim is added. Co-Authored-By: Claude Opus 5.5 --- docs/source/api/diffpy.cmirietveld.rst | 8 +++---- news/rename-peak-profiles.rst | 23 +++++++++++++++++++ .../{profiles.py => peak_profiles.py} | 0 ...test_profiles.py => test_peak_profiles.py} | 2 +- 4 files changed, 28 insertions(+), 5 deletions(-) create mode 100644 news/rename-peak-profiles.rst rename src/diffpy/cmirietveld/{profiles.py => peak_profiles.py} (100%) rename tests/{test_profiles.py => test_peak_profiles.py} (99%) diff --git a/docs/source/api/diffpy.cmirietveld.rst b/docs/source/api/diffpy.cmirietveld.rst index 79fbecf..92a2421 100644 --- a/docs/source/api/diffpy.cmirietveld.rst +++ b/docs/source/api/diffpy.cmirietveld.rst @@ -39,12 +39,12 @@ Submodules :undoc-members: :show-inheritance: -|profiles| ----------- +|peak_profiles| +--------------- -.. |profiles| replace:: diffpy.cmirietveld.profiles module +.. |peak_profiles| replace:: diffpy.cmirietveld.peak_profiles module -.. automodule:: diffpy.cmirietveld.profiles +.. automodule:: diffpy.cmirietveld.peak_profiles :members: :undoc-members: :show-inheritance: diff --git a/news/rename-peak-profiles.rst b/news/rename-peak-profiles.rst new file mode 100644 index 0000000..2ad2873 --- /dev/null +++ b/news/rename-peak-profiles.rst @@ -0,0 +1,23 @@ +**Added:** + +* No news added: Rename the unreleased ``profiles`` module to ``peak_profiles`` so it is not confused with srfit's ``Profile``. + +**Changed:** + +* + +**Deprecated:** + +* + +**Removed:** + +* + +**Fixed:** + +* + +**Security:** + +* diff --git a/src/diffpy/cmirietveld/profiles.py b/src/diffpy/cmirietveld/peak_profiles.py similarity index 100% rename from src/diffpy/cmirietveld/profiles.py rename to src/diffpy/cmirietveld/peak_profiles.py diff --git a/tests/test_profiles.py b/tests/test_peak_profiles.py similarity index 99% rename from tests/test_profiles.py rename to tests/test_peak_profiles.py index 5d03a66..dd34eb5 100644 --- a/tests/test_profiles.py +++ b/tests/test_peak_profiles.py @@ -5,7 +5,7 @@ ReflectionProfilePseudoVoigtTCH, ) -from diffpy.cmirietveld.profiles import PseudoVoigtProfile, TCHProfile +from diffpy.cmirietveld.peak_profiles import PseudoVoigtProfile, TCHProfile @pytest.mark.parametrize(