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 case of a multiselect dropdown becoming single when no selection #2404

Merged

Conversation

kecnry
Copy link
Member

@kecnry kecnry commented Aug 29, 2023

Description

This pull request fixes turning off multiselect mode for a dropdown when no selections are currently made. Previously this resulted in a traceback, but now applies the default selection for single-select mode (which may either be empty or the first entry, etc, depending on the options for that dropdown).

To reproduce:

  • load any viz tool with multiple layers and/or viewers
  • open plot options
  • select advanced multiselect mode in top right
  • in either viewer or layer, clear the selection
  • click the button again in the top right to enter single-select mode
  • on main, this crashes, but is handled gracefully in this PR (for plot options, the dropdown remains empty)

Note: further improvements to these edge cases could be made (to hide all other plot options information when either viewer or layer is empty, rather than showing empty widgets with "NULL", etc), but those are a larger effort and at least don't result in tracebacks right now.

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.
  • After merge, any internal documentations need updating (e.g., JIRA, Innerspace)?

@kecnry kecnry added the 💤 backport-v3.6.x on-merge: backport to v3.6.x label Aug 29, 2023
@kecnry kecnry added this to the 3.6.3 milestone Aug 29, 2023
@kecnry kecnry force-pushed the fix-multiselect-to-single-when-empty branch from 42e1a3a to 5c914a0 Compare August 29, 2023 20:06
@kecnry kecnry added the trivial Only needs one approval instead of two label Aug 29, 2023
@kecnry kecnry marked this pull request as ready for review August 29, 2023 20:11
@pllim pllim added the bug Something isn't working label Aug 29, 2023
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!

@codecov
Copy link

codecov bot commented Aug 29, 2023

Codecov Report

Patch coverage is 100.00% of modified lines.

Files Changed Coverage
jdaviz/core/template_mixin.py 100.00%

📢 Thoughts on this report? Let us know!.

@kecnry kecnry enabled auto-merge August 29, 2023 20:21
@pllim
Copy link
Contributor

pllim commented Aug 29, 2023

I think the RTD webhook is stuck, blocking auto merge. Since this PR doesn't touch docs, I am just going to merge it.

@pllim pllim disabled auto-merge August 29, 2023 20:23
@pllim pllim merged commit 1256253 into spacetelescope:main Aug 29, 2023
@lumberbot-app

This comment was marked as resolved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working trivial Only needs one approval instead of two 💤 backport-v3.6.x on-merge: backport to v3.6.x
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants