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 check_kw handling and changelog errors #528

Merged
merged 4 commits into from
Feb 28, 2025
Merged

Fix check_kw handling and changelog errors #528

merged 4 commits into from
Feb 28, 2025

Conversation

bhazelton
Copy link
Member

Description

This PR fixes some errors introduced in recent PRs.

I discovered errors in how #503 was implemented, so I fixed them here.

I also discovered that there were mistakes in changelog updates in #503 and #519 where changes were recorded as going into version 1.4.0 rather than into the unreleased section. These are fixed here as well.

Motivation and Context

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Reference simulation update or replacement
  • Documentation change (documentation changes only)
  • Version change
  • Build or continuous integration change

Checklist:

For all pull requests:

Bug fix checklist:

  • My fix includes a new test that breaks as a result of the bug (if possible).
  • All new and existing tests pass.
  • I have checked that I reproduce the reference simulations or if there are differences they are explained below (if appropriate). If there are changes that are correct, I will update the reference simulation files after this PR is merged.
  • I have checked (e.g., using the benchmarking tools) that this change does not significantly increase typical runtimes. If it does, I have included a justification in the comments on this PR.
  • I have updated the CHANGELOG.

Copy link

codecov bot commented Feb 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (24c2a87) to head (88c7c01).
Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #528   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           10        10           
  Lines         2025      2019    -6     
=========================================
- Hits          2025      2019    -6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

steven-murray
steven-murray previously approved these changes Feb 27, 2025
Copy link
Contributor

@steven-murray steven-murray left a comment

Choose a reason for hiding this comment

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

Thanks @bhazelton. This all looks good to me!

Copy link
Contributor

@steven-murray steven-murray left a comment

Choose a reason for hiding this comment

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

hera_sim tests are failing for two reasons. One of them is that they use the check_kw argument for _complete_uvdata, so I've made a PR to fix that. The other however doesn't seem to be to do with hera_sim itself -- it's an error that telecfg is not a key in extra_keywords, and the error seems to be coming from a function in pyuvsim itself, so we should check that out.

@bhazelton
Copy link
Member Author

hera_sim tests are failing for two reasons. One of them is that they use the check_kw argument for _complete_uvdata, so I've made a PR to fix that. The other however doesn't seem to be to do with hera_sim itself -- it's an error that telecfg is not a key in extra_keywords, and the error seems to be coming from a function in pyuvsim itself, so we should check that out.

I fixed the extra keywords problem, but if hera_sim is calling the (private) _complete_uvdata method then maybe I should just put the check_kw option back in. I took it out because I figured only trusted code was calling it.

@steven-murray
Copy link
Contributor

I fixed the extra keywords problem, but if hera_sim is calling the (private) _complete_uvdata method then maybe I should just put the check_kw option back in. I took it out because I figured only trusted code was calling it.

We understand that it's a private method, so API changes are allowed to happen. If it's made a public API, then more stability would be required, but I think it's fine. It's a simple fix on the hera-sim end.

@bhazelton
Copy link
Member Author

@steven-murray if you're good with this now can you re-approve?

Copy link
Contributor

@steven-murray steven-murray left a comment

Choose a reason for hiding this comment

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

Great!

@bhazelton bhazelton merged commit a1ee29d into main Feb 28, 2025
43 of 45 checks passed
@bhazelton bhazelton deleted the cleanup branch February 28, 2025 17:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants