Skip to content

chore: deprecate methods in symmetryutilities.py#165

Merged
sbillinge merged 2 commits intodiffpy:v3.4.0from
stevenhua0320:symmetryutilities-deprecate
Feb 24, 2026
Merged

chore: deprecate methods in symmetryutilities.py#165
sbillinge merged 2 commits intodiffpy:v3.4.0from
stevenhua0320:symmetryutilities-deprecate

Conversation

@stevenhua0320
Copy link
Contributor

@sbillinge ready to review. Note that I forgot to add the deprecation message for the readStr in the PDFFitStructure class in the past PR, so I add it here. Also note that for symmetryutilities.py there are a lot of new-written functions that created with no tests, I would consider how we handle with it in the next PR.

@stevenhua0320 stevenhua0320 changed the title chore: deprecate methods in chore: deprecate methods in symmetryutilities.py Feb 24, 2026
@codecov
Copy link

codecov bot commented Feb 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.01%. Comparing base (d09a89c) to head (9a4195a).
⚠️ Report is 4 commits behind head on v3.4.0.

Additional details and impacted files
@@            Coverage Diff             @@
##           v3.4.0     #165      +/-   ##
==========================================
+ Coverage   98.99%   99.01%   +0.01%     
==========================================
  Files          13       13              
  Lines        1995     2024      +29     
==========================================
+ Hits         1975     2004      +29     
  Misses         20       20              
Files with missing lines Coverage Δ
tests/test_symmetryutilities.py 99.71% <100.00%> (+0.02%) ⬆️
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Contributor

@sbillinge sbillinge left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please see comment

readStr_deprecation_msg = build_deprecation_message(
base,
"isSpaceGroupLatPar",
"is_space_group_lat_par",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest that we are consistent and abbreviate lattice to latt everywhere and parameter to parm or maybe better, param. Either way I think it is quite important that we use the same abbreviation for things everywhere they appear.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Got it, I have made all lat to latt and parameter to parms since we have declared the name for parameter in the previous PR to be consistent. Furthermore, I realized I'm dumb to forget to edit the name of the method inside the argument, it should be readStr and read_structure here. See the latest commit.

@sbillinge sbillinge merged commit 42d3828 into diffpy:v3.4.0 Feb 24, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants