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

"Imviz Line Profiles (XY)" renamed to "Image Profiles (XY)" #3121

Merged
merged 2 commits into from
Jul 30, 2024

Conversation

kecnry
Copy link
Member

@kecnry kecnry commented Jul 30, 2024

Description

This pull request renames "Imviz Line Profiles (XY)" to "Line Profiles (XY)" "Image Profiles (XY)" along with deprecation for API access (although the plugin API itself is still not exposed).

If we want to name this to something more general (especially if we would ever want to re-use this for 2d spectra and want to avoid confusion with spectral lines) now would be the time to do so.

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 imviz plugin Label for plugins common to multiple configurations labels Jul 30, 2024
@kecnry kecnry added this to the 4.0 milestone Jul 30, 2024
@kecnry kecnry marked this pull request as ready for review July 30, 2024 13:04
Comment on lines 139 to 149
if 'Orientation' in plugins:
# renamed in 3.9
plugins['Links Control'] = plugins['Orientation']._obj.user_api
plugins['Links Control']._deprecation_msg = 'in the future, the formerly named \"Links Control\" plugin will only be available by its new name: \"Orientation\".' # noqa
if 'Canvas Rotation' in plugins:
# removed in 3.9
plugins['Canvas Rotation']._deprecation_msg = 'this functionality will be removed in favor of the implementation for rotation in the \"Orientation\" plugin.' # noqa
if 'Export' in plugins:
# renamed in 3.9
plugins['Export Plot'] = plugins['Export']._obj.user_api
plugins['Export Plot']._deprecation_msg = 'in the future, the formerly named \"Export Plot\" plugin will only be available by its new name: \"Export\".' # noqa
Copy link
Member Author

Choose a reason for hiding this comment

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

I think these have now been more than 2 releases, so maybe we can remove for 4.0?

Copy link
Member Author

Choose a reason for hiding this comment

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

(I don't think that belongs in scope here, so I made a note in the 4.0 release ticket)

Copy link

codecov bot commented Jul 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.93%. Comparing base (3de1b08) to head (65adcf1).
Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3121      +/-   ##
==========================================
+ Coverage   88.91%   88.93%   +0.01%     
==========================================
  Files         111      112       +1     
  Lines       17365    17399      +34     
==========================================
+ Hits        15440    15473      +33     
- Misses       1925     1926       +1     

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

@pllim
Copy link
Contributor

pllim commented Jul 30, 2024

Any downstream notebooks need updating to go with this?

CHANGES.rst Outdated Show resolved Hide resolved
@kecnry
Copy link
Member Author

kecnry commented Jul 30, 2024

Any downstream notebooks need updating to go with this?

Not that I know, there is currently no API access besides showing/opening the plugin, so I doubt any notebook makes use of this. If it does, they'll start seeing the "deprecation" message and hopefully know how to update before we remove that.

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.

Looks uncontroversial enough. Thanks!

@pllim pllim enabled auto-merge (squash) July 30, 2024 13:46
@kecnry kecnry disabled auto-merge July 30, 2024 13:46
@kecnry
Copy link
Member Author

kecnry commented Jul 30, 2024

(let's not merge until we have a chance to discuss generalizing the name - just canceled auto-merge)

@pllim
Copy link
Contributor

pllim commented Jul 30, 2024

Oh OK... I thought the ticket was pretty clear. Sorry if I misunderstood.

@kecnry kecnry changed the title remove "Imviz" from "Line Profiles XY" plugin name "Imviz Line Profiles (XY)" renamed to "Image Profiles (XY)" Jul 30, 2024
@kecnry
Copy link
Member Author

kecnry commented Jul 30, 2024

@pllim - I did find one mention in a concept notebook and updated that here along with changing to "Image Profiles (XY)" as discussed offline. Are you ok with marking this as trivial and merging from your previous approval?

@kecnry kecnry added api API change trivial Only needs one approval instead of two labels Jul 30, 2024
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.

LGTM. Thanks!

@pllim pllim merged commit 1a210d1 into spacetelescope:main Jul 30, 2024
19 checks passed
@kecnry kecnry deleted the line-profiles-rename branch July 30, 2024 17:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api API change imviz 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