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

Revert combination mode to before import_region call #3255

Merged
merged 3 commits into from
Oct 25, 2024

Conversation

javerbukh
Copy link
Contributor

Description

This pull request reverts the combination mode to before the import_region(region, combination_mode=<list>) call.

Change log entry

  • Is a change log needed? If yes, is it added to CHANGES.rst? If you want to avoid merge conflicts,
    list the proposed change log here for review and add to CHANGES.rst before merge. If no, maintainer
    should add a no-changelog-entry-needed label.

Checklist for package maintainer(s)

This checklist is meant to remind the package maintainer(s) who will review this pull request of some common things to look for. This list is not exhaustive.

  • Are two approvals required? Branch protection rule does not check for the second approval. If a second approval is not necessary, please apply the trivial label.
  • Do the proposed changes actually accomplish desired goals? Also manually run the affected example notebooks, if necessary.
  • Do the proposed changes follow the STScI Style Guides?
  • Are tests added/updated as required? If so, do they follow the STScI Style Guides?
  • Are docs added/updated as required? If so, do they follow the STScI Style Guides?
  • Did the CI pass? If not, are the failures related?
  • Is a milestone set? Set this to bugfix milestone if this is a bug fix and needs to be released ASAP; otherwise, set this to the next major release milestone. Bugfix milestone also needs an accompanying backport label.
  • After merge, any internal documentations need updating (e.g., JIRA, Innerspace)?

@github-actions github-actions bot added the plugin Label for plugins common to multiple configurations label Oct 24, 2024
@javerbukh javerbukh added the no-changelog-entry-needed changelog bot directive label Oct 24, 2024
@javerbukh javerbukh added this to the 4.1 milestone Oct 24, 2024
Copy link

codecov bot commented Oct 24, 2024

Codecov Report

Attention: Patch coverage is 80.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 88.63%. Comparing base (b47c128) to head (4d67ced).
Report is 6 commits behind head on main.

Files with missing lines Patch % Lines
...igs/default/plugins/subset_plugin/subset_plugin.py 80.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3255   +/-   ##
=======================================
  Coverage   88.63%   88.63%           
=======================================
  Files         125      125           
  Lines       18779    18781    +2     
=======================================
+ Hits        16644    16646    +2     
  Misses       2135     2135           

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

@pllim
Copy link
Contributor

pllim commented Oct 25, 2024

Is this testable as a unit test?

Comment on lines +973 to +974
# Revert edit mode to before the import_region call
self.app.session.edit_subset_mode.mode = previous_mode
Copy link
Member

Choose a reason for hiding this comment

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

is there anything above that could actually raise an error (not caught by bad_regions) where the revert should still happen?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Not that I could see, does anything stick out to you?

Copy link
Member

Choose a reason for hiding this comment

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

I guess we don't need to catch bugs in the code itself, so bad_regions should be sufficient to make sure the revert happens here. Thanks!

@@ -198,6 +199,7 @@ def test_import_spectral_region(cubeviz_helper, spectrum1d_cube, spec_regions, m
subsets = cubeviz_helper.app.get_subsets()
assert len(subsets) == len_subsets
assert len(subsets['Subset 1']) == len_subregions
assert cubeviz_helper.app.session.edit_subset_mode.mode == ReplaceMode
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@pllim I added this and the lines below, let me know if that is sufficient coverage.

Copy link
Member

@kecnry kecnry left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@pllim pllim left a comment

Choose a reason for hiding this comment

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

Thanks!

@pllim pllim merged commit b6bf280 into spacetelescope:main Oct 25, 2024
18 of 19 checks passed
rosteen pushed a commit that referenced this pull request Oct 29, 2024
* Revert combination mode to before import_region call

* Add unit test for reverting to previous edit mode

* Remove whitespace
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog-entry-needed changelog bot directive plugin Label for plugins common to multiple configurations Ready for final review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants