Skip to content
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.

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

Improve test comments under @pytest.mark.parametrize in test_diffraction_objects.py #273

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

bobleesj
Copy link
Contributor

@bobleesj bobleesj commented Dec 23, 2024

Some battle-tested practices being adopted:

  • Replace UC to C
  • Add higher-level test function comment before starting "C"
  • Use "x, y, z (provided), expect blah blah blah" format for consistency

cc' @yucongalicechen

Copy link

codecov bot commented Dec 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.68%. Comparing base (8107874) to head (499a1c3).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #273   +/-   ##
=======================================
  Coverage   98.68%   98.68%           
=======================================
  Files           8        8           
  Lines         379      379           
=======================================
  Hits          374      374           
  Misses          5        5           
Files with missing lines Coverage Δ
tests/test_diffraction_objects.py 100.00% <100.00%> (ø)

@bobleesj
Copy link
Contributor Author

@sbillinge ready for review.

@yucongalicechen , the part that is remaining is the test_scale_to function.

The existing comments like# C2: Same length x-arrays with exact x-value match, # C3: Same length x-arrays with approximate x-value match were abit hard for me to understand what's being tested. Would you mind improving this test comments for test_scale_to using the above format?

@bobleesj
Copy link
Contributor Author

(Just added a quick fix) pls see my comments right above

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.

1 participant