Skip to content

fix: point the camelCase CF deprecations to cmipdf version. - #238

Merged
sbillinge merged 1 commit into
diffpy:mainfrom
cadenmyers13:cf-names-match-3.4.0
Oct 27, 2026
Merged

fix: point the camelCase CF deprecations to cmipdf version.#238
sbillinge merged 1 commit into
diffpy:mainfrom
cadenmyers13:cf-names-match-3.4.0

Conversation

@cadenmyers13

@cadenmyers13 cadenmyers13 commented Oct 26, 2026

Copy link
Copy Markdown
Contributor

lognormalSphericalCF, shellCF and shellCF2 were deprecated in 3.4.0 in favor of lognormal_spherical_particle and shell_particle. Their messages now named diffpy.cmipdf's lognormal_spherical_distribution and spherical_shell.

@cadenmyers13 @claude
fix: point the camelCase CF deprecations at the srfit 3.4.0 names in …
3b0d217 
…cmipdf

lognormalSphericalCF, shellCF and shellCF2 were deprecated in 3.4.0 in
favor of lognormal_spherical_particle and shell_particle. Their messages
now named diffpy.cmipdf's lognormal_spherical_distribution and
spherical_shell, which would make users who already moved to the 3.4.0
names rename again. diffpy.cmipdf adopts the 3.4.0 names instead, so the
messages point there. news/pdf-dep.rst is corrected to match.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@codecov

codecov Bot commented Oct 26, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 84.21%. Comparing base (507aa4e) to head (3b0d217).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files 
@@            Coverage Diff             @@
##             main     #238      +/-   ##
==========================================
- Coverage   84.95%   84.21%   -0.75%     
==========================================
  Files          44       46       +2     
  Lines        4886     5094     +208     
==========================================
+ Hits         4151     4290     +139     
- Misses        735      804      +69
Files with missing lines Coverage Δ
tests/test_characteristicfunctions.py 54.16% <ø> (-0.24%) ⬇️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@cadenmyers13

cadenmyers13 commented Oct 26, 2026

Copy link
Copy Markdown
Contributor Author

@sbillinge ready for review

I had renamed some functions in cmipdf and they didn't match the function names that srfit pointed to. I realized that this would mean we'd have to deprecate the function that is being pointed at by the deprecated function 😅. Rather than doing that i just went with the srfit 3.4.0 function names.

@cadenmyers13 cadenmyers13 mentioned this pull request Oct 26, 2026
Merged
@sbillinge
sbillinge merged commit 2894e8a into diffpy:main Oct 27, 2026
6 of 7 checks passed
@sbillinge

sbillinge commented Oct 27, 2026

Copy link
Copy Markdown
Contributor

@sbillinge ready for review

I had renamed some functions in cmipdf and they didn't match the function names that srfit pointed to. I realized that this would mean we'd have to deprecate the function that is being pointed at by the deprecated function 😅. Rather than doing that i just went with the srfit 3.4.0 function names.

its ok this way. Aren't all the references internal?

@cadenmyers13
cadenmyers13 deleted the cf-names-match-3.4.0 branch October 27, 2026 13:40
@cadenmyers13

cadenmyers13 commented Oct 27, 2026

Copy link
Copy Markdown
Contributor Author

its ok this way. Aren't all the references internal?

@sbillinge No, people use these in the scripts. Nothing changes here I just want to document why i was changing snake_case names in this PR. TLDR, nothing to worry about

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@cadenmyers13 @sbillinge