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

Rename monochromatic color mode and add descriptions #2894

Merged
merged 6 commits into from
May 24, 2024

Conversation

kecnry
Copy link
Member

@kecnry kecnry commented May 24, 2024

Description

This pull request renames the "Monochromatic" color mode option to "Color" and adds descriptions within the dropdown. Setting color_mode = 'monochromatic' from the plot options plugin API is still supported with a deprecation message.

Screen.Recording.2024-05-24.at.11.14.37.AM.mov

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

@kecnry kecnry added this to the 4.0 milestone May 24, 2024
@github-actions github-actions bot added the plugin Label for plugins common to multiple configurations label May 24, 2024
@kecnry kecnry force-pushed the color_mode_descriptions branch 2 times, most recently from 983fb37 to a2f901d Compare May 24, 2024 15:20
@kecnry kecnry marked this pull request as ready for review May 24, 2024 15:28
Copy link
Contributor

@cshanahan1 cshanahan1 left a comment

Choose a reason for hiding this comment

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

There are several notebooks (imviz_colorbar_mpl.ipynb, cubeviz_ndarray_gif.ipynb, imviz_dithered_gwcs.ipynb) that have references to 'monochromatic' that need to be updated.

Copy link

codecov bot commented May 24, 2024

Codecov Report

Attention: Patch coverage is 42.85714% with 4 lines in your changes missing coverage. Please review.

Project coverage is 88.70%. Comparing base (0b11723) to head (5a44dcc).
Report is 172 commits behind head on main.

Files Patch % Lines
jdaviz/core/template_mixin.py 50.00% 3 Missing ⚠️
...nfigs/default/plugins/plot_options/plot_options.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2894      +/-   ##
==========================================
- Coverage   88.71%   88.70%   -0.02%     
==========================================
  Files         111      111              
  Lines       17081    17086       +5     
==========================================
+ Hits        15154    15156       +2     
- Misses       1927     1930       +3     

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

Copy link
Contributor

@cshanahan1 cshanahan1 left a comment

Choose a reason for hiding this comment

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

There are also a few references to "monochromatic" in docs/imviz/displayimages.rst that need to be updated.

@cshanahan1
Copy link
Contributor

Otherwise looks good to me and ill approve once those are fixed!

@kecnry
Copy link
Member Author

kecnry commented May 24, 2024

@cshanahan1 - good call! Do you see anywhere else that I missed in the docs?

@cshanahan1
Copy link
Contributor

@kecnry i dont think so, i dont see any more

@javerbukh
Copy link
Contributor

Changing the color mode from Colormap to Color changes the background of the image viewer from white to black. Is this expected behavior?

@pllim
Copy link
Contributor

pllim commented May 24, 2024

Is this expected behavior?

If it isn't, I like the new behavior. Looks nicer in dark mode. 😆

@kecnry
Copy link
Member Author

kecnry commented May 24, 2024

Changing the color mode from Colormap to Color changes the background of the image viewer from white to black. Is this expected behavior?

Do you only see that in this PR? I believe that was from upstream changes in glue by @bmorris3

Copy link
Contributor

@javerbukh javerbukh left a comment

Choose a reason for hiding this comment

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

@kecnry You're correct, it is also on main. In that case this looks good!

@kecnry kecnry force-pushed the color_mode_descriptions branch from 6ff6055 to 5a44dcc Compare May 24, 2024 19:18
@kecnry kecnry enabled auto-merge (squash) May 24, 2024 19:27
@kecnry kecnry merged commit 8f65073 into spacetelescope:main May 24, 2024
16 checks passed
@kecnry kecnry deleted the color_mode_descriptions branch May 24, 2024 19:36
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
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.

4 participants