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

UI-searchable API methods/attributes #3384

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

kecnry
Copy link
Member

@kecnry kecnry commented Jan 9, 2025

Description

This pull request implements plugin-tray filtering of plugins by their exposed methods/attributes. (Note that this also helps expose to us places where we expose args/kwargs that probably shouldn't be exposed and should work to clean those up 🐱)

Screen.Recording.2025-01-09.at.11.35.59.AM.mov

Note that currently this filtering still happens when API hints are off (so "Plot Options" still appears for a search of "RGB"), but that could easily be changed if preferred.

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.2 milestone Jan 9, 2025
@github-actions github-actions bot added the embed Regarding issues with front-end embedding label Jan 9, 2025
@kecnry
Copy link
Member Author

kecnry commented Jan 9, 2025

Tests won't pass due to deprecated methods until rebased on #3385. In the future, if we have more deprecated plugin methods, we'll either have to manually exclude them from this list or filter the deprecation warning when building the list.

Copy link

codecov bot commented Jan 10, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.05%. Comparing base (ae2aae8) to head (66f0914).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #3384      +/-   ##
==========================================
+ Coverage   88.03%   88.05%   +0.01%     
==========================================
  Files         127      127              
  Lines       19722    19729       +7     
==========================================
+ Hits        17363    17372       +9     
+ Misses       2359     2357       -2     

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

@kecnry kecnry marked this pull request as ready for review January 10, 2025 13:44
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.

Demo was cool. Thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
embed Regarding issues with front-end embedding Ready for final review UI/UX😍
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants