Refactor test_scale_to function - continue to establish good practices

[bobleesj]

The goal of this PR is to demonstrate how to refactor a specific test function.

• Use variable names that are concise, clear, yet does not lose info
• Correctly use @pytest.mark.parametrize to init objects
• Differentiate info vs warning messages for end-users

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (2bc765f) to head (206d39d).
Report is 12 commits behind head on main.

Additional details and impacted files

@@ Coverage Diff @@## main #255 +/- ##
=========================================
Coverage 100.00% 100.00% =========================================
Files 8 8 Lines 380 378 -2 =========================================
- Hits 380 378 -2 

Files with missing lines	Coverage Δ
tests/test_diffraction_objects.py	100.00% <100.00%> (ø)

[bobleesj]

@sbillinge ready for review - @yucongalicechen continuing to refactor test functions for future maintenance.

[sbillinge]

looks great....but please see inline.

[sbillinge]

This is supposed to be an info not a warning. I think we want INFO and change wmsg to imsg in the name. Make sure it is a print and not a warning.warn in the code.

The group standard could be that a warning means that something is wrong, albeit not error generating.

Here it is "expected" that we will have infinities sometimes and we want to handle them if possible. So nothing is wrong but we want the user to alerted so they understand any magic.

Not sure if that all makes sense.

[bobleesj]

quick note to myself - fix typo

[sbillinge]

@bobleesj LGTM. I am happy to merge whenever you are ready. Great improvement. Not sure if you did the high level scoping sttement. I have to board my flight though....

[bobleesj]

@bobleesj LGTM. I am happy to merge whenever you are ready. Great improvement. Not sure if you did the high level scoping sttement. I have to board my flight though....

@sbillinge I will take some time to internalize the comments and make new commits later today. Thanks a lot! Safe travels to Africa.

[bobleesj]

@sbillinge Ready for review - the last commit is just quick fix from UC to Case as noted and adding "No news added".

For higher-level ones, I created separate issues: 1) how to enforce BG members to define testing scope before writing one 2) grouping test cases 3) review warning/info/error runtime error messages

[bobleesj]

Noted the additional commits made with higher-level test comments.