Skip to content

refactor: rename profiles module to peak_profiles #10

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

Merged
sbillinge merged 2 commits into from
Oct 31, 2026
Merged

refactor: rename profiles module to peak_profiles #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dcca1fc
refactor: rename profiles module to peak_profiles
cadenmyers13 Oct 29, 2026
619dd53
Merge remote-tracking branch 'upstream/main' into rename-peak-profiles
cadenmyers13 Oct 30, 2026
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
8 changes: 4 additions & 4 deletions docs/source/api/diffpy.cmirietveld.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
23 changes: 23 additions & 0 deletions news/rename-peak-profiles.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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:**

* <news item>

**Deprecated:**

* <news item>

**Removed:**

* <news item>

**Fixed:**

* <news item>

**Security:**

* <news item>
0 src/diffpy/cmirietveld/profiles.py → src/diffpy/cmirietveld/peak_profiles.py
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion tests/test_profiles.py → tests/test_peak_profiles.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
ReflectionProfilePseudoVoigtTCH,
)

from diffpy.cmirietveld.profiles import PseudoVoigtProfile, TCHProfile
from diffpy.cmirietveld.peak_profiles import PseudoVoigtProfile, TCHProfile


@pytest.mark.parametrize(
Expand Down
Loading