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.

Sign up for GitHub

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

Jump to bottom

API hints tweaks #3159

Merged
merged 7 commits into from
Aug 21, 2024
Merged

API hints tweaks #3159

merged 7 commits into from
Aug 21, 2024

Conversation

kecnry
Copy link
Member

@kecnry kecnry commented Aug 21, 2024 •
edited
Loading

Description

This pull request is a follow-up to #3137 to give the flexibility for inherited plugins (i.e. time selector in lcviz or cube extraction in lcviz/rampviz) to override the plugin key shown in the API hints. It also makes the following small tweaks:

  • fix the styling on a component in the slice plugin
  • fix styling for "apply RGB presets" button in plot options
  • fix options for "align_by" in orientation plugin to be the same options as the API
  • add quotes around the color string in color picker

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 added 2 commits August 21, 2024 08:45
@kecnry
fix hint-styling in slice plugin
16592fa
@kecnry
allow downstream override of plugin key
de97827 
when inheriting from upstream plugin, currently only used for Slice (called Time Selector in lcviz) and cubeviz's Spectral Extraction (will be used downstream by both lcviz and rampviz)
@github-actions github-actions bot added cubeviz plugin Label for plugins common to multiple configurations labels Aug 21, 2024
@kecnry kecnry added this to the 4.0 milestone Aug 21, 2024
@kecnry kecnry added the trivial Only needs one approval instead of two label Aug 21, 2024
@kecnry kecnry mentioned this pull request Aug 21, 2024
Merged
@kecnry kecnry marked this pull request as ready for review August 21, 2024 12:55
kecnry
kecnry commented Aug 21, 2024
View reviewed changes
jdaviz/configs/cubeviz/plugins/slice/slice.vue
plugin_key="Slice"
:plugin_key="plugin_key || 'Slice'"
Copy link
Member Author

Choose a reason for hiding this comment

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

see https://github.com/spacetelescope/lcviz/pull/133/files#diff-32e4b267e193d9c8832ff3c8b50929e8fc6f755b802f7dad26bd910cc22375cfR42 for how this will be used in lcviz to override the API hint to access the plugin from plugins['Slice'] to plugins['Time Selector'].

Copy link
Contributor

Choose a reason for hiding this comment

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

Looks surprising at first, but super simple in the end. Neat!

bmorris3
bmorris3 approved these changes Aug 21, 2024
View reviewed changes
Copy link
Contributor

@bmorris3 bmorris3 left a comment

Choose a reason for hiding this comment

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

Thanks, this looks useful and sustainable.

jdaviz/configs/cubeviz/plugins/slice/slice.vue
plugin_key="Slice"
:plugin_key="plugin_key || 'Slice'"
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks surprising at first, but super simple in the end. Neat!

@kecnry
Copy link
Member Author

kecnry commented Aug 21, 2024

test failures unrelated and showing on other PRs as well, so I'm ignoring and merging since this PR doesn't touch any related logic.

@kecnry kecnry merged commit 3ee85ce into spacetelescope:main Aug 21, 2024
15 of 17 checks passed
@kecnry kecnry deleted the api-hints-2 branch August 21, 2024 18:14
@kecnry kecnry mentioned this pull request Aug 22, 2024
Merged
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bmorris3 bmorris3 bmorris3 approved these changes

@rosteen rosteen Awaiting requested review from rosteen rosteen is a code owner

@javerbukh javerbukh Awaiting requested review from javerbukh javerbukh is a code owner

@pllim pllim Awaiting requested review from pllim pllim is a code owner

@haticekaratay haticekaratay Awaiting requested review from haticekaratay haticekaratay is a code owner

@cshanahan1 cshanahan1 Awaiting requested review from cshanahan1 cshanahan1 is a code owner

@gibsongreen gibsongreen Awaiting requested review from gibsongreen gibsongreen is a code owner

Assignees
No one assigned
Labels
cubeviz plugin Label for plugins common to multiple configurations trivial Only needs one approval instead of two
Projects
None yet
Milestone
4.0
Development

Successfully merging this pull request may close these issues.
2 participants
@kecnry @bmorris3