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

fix: warn about using use_pixel_beams #222

Merged
merged 5 commits into from
Apr 21, 2022
Merged

Conversation

steven-murray
Copy link
Contributor

This sets the default value of use_pixel_beams to False, because it's a bad idea.

Since it changes the API (in the sense of a default change), but I didn't want to make it a major-version thing, I emit a warning when the default value is used.

@codecov
Copy link

codecov bot commented Apr 20, 2022

Codecov Report

Merging #222 (7c71f29) into main (9ba2f10) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main     #222   +/-   ##
=======================================
  Coverage   96.54%   96.55%           
=======================================
  Files          24       24           
  Lines        2809     2813    +4     
=======================================
+ Hits         2712     2716    +4     
  Misses         97       97           
Impacted Files Coverage Δ
hera_sim/visibilities/vis_cpu.py 93.57% <100.00%> (+0.18%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d8b3355...7c71f29. Read the comment docs.

Copy link
Contributor

@r-pascua r-pascua left a comment

Choose a reason for hiding this comment

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

This looks good to me. I agree that this it feels silly to make a new major version release just for changing a default parameter, and that raising a warning is a nice middle ground. Thanks!

@steven-murray steven-murray merged commit 976a794 into main Apr 21, 2022
@steven-murray steven-murray deleted the vis-cpu-pixel-beams branch April 21, 2022 17:21
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