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 reference to plugins in metadata #2826

Merged
merged 2 commits into from
Apr 23, 2024

Conversation

kecnry
Copy link
Member

@kecnry kecnry commented Apr 23, 2024

Description

This pull request fixes internal references to plugin names which changed to be the human-friendly name in #2680 (not yet released), but missed updating a few cases, resulting in moment maps not being linked correctly.

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)?

* changed to be the human-friendly name in spacetelescope#2680, but missed updating a few cases, resulting in moment maps not being linked correctly
@kecnry kecnry added this to the 3.10 milestone Apr 23, 2024
@kecnry kecnry added the no-changelog-entry-needed changelog bot directive label Apr 23, 2024
@kecnry kecnry marked this pull request as ready for review April 23, 2024 18:43
Copy link

codecov bot commented Apr 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.88%. Comparing base (a39a0fe) to head (375383f).
Report is 9 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2826      +/-   ##
==========================================
- Coverage   88.88%   88.88%   -0.01%     
==========================================
  Files         111      111              
  Lines       16983    16978       -5     
==========================================
- Hits        15096    15091       -5     
  Misses       1887     1887              

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

as regression test. This check currently fails on main but should be passing
as part of PR 2826
@@ -128,6 +128,10 @@ def test_moment_calculation(cubeviz_helper, spectrum1d_cube, tmp_path):
assert len(dc.links) == 22
assert len(dc.external_links) == 4 # pixel linked
# Link 3D z to 2D x and 3D y to 2D y
assert (dc.external_links[0].cids1[0].label == "Pixel Axis 0 [z]" and
Copy link
Contributor

Choose a reason for hiding this comment

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

I confirmed locally that this test fails on main without this patch as follows:

E       AssertionError: assert ('Pixel Axis 0 [z]' == 'Pixel Axis 0 [z]'
E
E           Pixel Axis 0 [z] and 'Pixel Axis 0 [y]' == 'Pixel Axis 1 [x]'
E
E         - Pixel Axis 1 [x]
E         ?            ^  ^
E         + Pixel Axis 0 [y]
E         ?            ^  ^)

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.

Wow, the fix is very subtle. Thanks for hunting it down. I added a check as regression test. I think this is good to merge once CI is green. No need for second review.

@pllim pllim added trivial Only needs one approval instead of two bug Something isn't working Affects-dev changelog bot directive cubeviz plugin Label for plugins common to multiple configurations labels Apr 23, 2024
@kecnry
Copy link
Member Author

kecnry commented Apr 23, 2024

Thanks for tracking down the offending PR and adding the test! 🎉

@kecnry kecnry merged commit 638f852 into spacetelescope:main Apr 23, 2024
32 of 34 checks passed
@kecnry kecnry deleted the fix-plugin-name-refs branch April 23, 2024 20:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Affects-dev changelog bot directive bug Something isn't working cubeviz no-changelog-entry-needed changelog bot directive plugin Label for plugins common to multiple configurations trivial Only needs one approval instead of two
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants