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 b7fe199..d16d454 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(