Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Remove things deprecated since v3.9 #2878

Merged
merged 2 commits into from
May 22, 2024

Conversation

pllim
Copy link
Contributor

@pllim pllim commented May 16, 2024

Description

This pull request is to remove API and plugin that were deprecated since v3.9.

Fix #2672

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

@pllim pllim added the api API change label May 16, 2024
@pllim pllim added this to the 4.0 milestone May 16, 2024
@github-actions github-actions bot added documentation Explanation of code and concepts cubeviz specviz imviz plugin Label for plugins common to multiple configurations labels May 16, 2024
@pllim
Copy link
Contributor Author

pllim commented May 16, 2024

I think there are JIRA tickets for these but I cannot find them.

@pllim pllim force-pushed the rm-depre-since-3.9 branch from 06c28b5 to 27ded75 Compare May 16, 2024 21:21
@pllim pllim marked this pull request as ready for review May 16, 2024 21:39
Copy link

codecov bot commented May 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.68%. Comparing base (3ac9bfb) to head (27ded75).
Report is 3 commits behind head on main.

Current head 27ded75 differs from pull request most recent head 2b68621

Please upload reports for the commit 2b68621 to get more accurate results.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2878      +/-   ##
==========================================
- Coverage   88.72%   88.68%   -0.05%     
==========================================
  Files         111      109       -2     
  Lines       17102    16993     -109     
==========================================
- Hits        15174    15070     -104     
+ Misses       1928     1923       -5     

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

@pllim pllim added the trivial Only needs one approval instead of two label May 21, 2024
Comment on lines 399 to 404
.. _rotate-canvas:

Canvas Rotation
===============

.. note::

This plugin is deprecated in favor of rotation via :ref:`imviz-orientation` and will be removed
in a future release.

The canvas rotation plugin allows rotating and horizontally flipping the image to any arbitrary
value by rotating the canvas axes themselves. Note that this does not affect the underlying data, and
exporting data to the notebook via the API will therefore not exhibit the same rotation.

The :ref:`imviz-compass` will also rotate (and flip) accordingly, but will show the zoom box
corresponding to the zoom limits, not the region shown in the viewer itself.

Presets are provided to reset the orientation as well as to set north up and east either to the
right or the left, as well as a slider and input to set the angle and a switch to set whether the
axes should be flipped horizontally after applying the rotation (a vertical flip can be achieved
via a 180 deg rotation and a horizontal flip).

Due to browser limitations, Canvas Rotation is only available on Chromium-based browsers.
This plugin was removed in Jdaviz v4.0, use :ref:`imviz-orientation` instead.
Copy link
Member

Choose a reason for hiding this comment

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

when (if ever) can we remove this section entirely (or maybe hide it somewhere but keep the link from breaking)?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

.. _rotate-canvas: needs a section to work, but it doesn't have to be on this page. And we can always break the doc anchor link in the future, or even in this PR if you don't think anyone is using it or it doesn't matter.

Copy link
Member

Choose a reason for hiding this comment

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

maybe we can create a page dedicated to removed/deprecated stuff and migrate everything there? I don't suspect this was widely used, so it would be nice to clean it up and remove it from the main plugin page, but we can also revisit that later down the road if you think it should remain here for a little while.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

OK for simplicity, I just completely removed the section in this PR. If anyone complains about broken link, they can send in help call but like you said, probably no one. Can we merge now? Thanks!

Copy link
Member

Choose a reason for hiding this comment

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

Yep, already approved

@pllim pllim enabled auto-merge (squash) May 22, 2024 14:58
@pllim pllim merged commit d4f399e into spacetelescope:main May 22, 2024
16 checks passed
@pllim pllim deleted the rm-depre-since-3.9 branch May 22, 2024 15:17
@kecnry kecnry mentioned this pull request Nov 7, 2024
9 tasks
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
api API change cubeviz documentation Explanation of code and concepts imviz plugin Label for plugins common to multiple configurations specviz trivial Only needs one approval instead of two
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove deprecated Canvas Rotation plugin
2 participants