data-menu: API hints

[kecnry]

Description

This pull request moves API hint toggles from the plugin to the app-level and implements API hints for the data-menu.

Screen.Recording.2024-11-08.at.3.24.35.PM.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)?

[codecov]

Codecov Report

Attention: Patch coverage is 90.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 88.81%. Comparing base (6fc4566) to head (7676963).
Report is 6 commits behind head on main.

Files with missing lines	Patch %	Lines
...viz/configs/default/plugins/data_menu/data_menu.py	75.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3274      +/-   ##
==========================================
- Coverage   88.81%   88.81%   -0.01%     
==========================================
  Files         125      125              
  Lines       18960    18968       +8     
==========================================
+ Hits        16839    16846       +7     
- Misses       2121     2122       +1     

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

[camipacifici]

I really like it!
The only thing that took me a tiny bit to figure out is the toggle for keeping the hints available for copy/paste. I kept clicking on the lock instead of on the icon and nothing was happening. Then I clicked on the icon. I think it is because the tooltip is also on the lock.

[kecnry]

@gibsongreen mentioned suggestions for the icon as well, maybe we can get a custom icon from @Jenneh for that down the road. I couldn't find anything off-the-shelf as a single icon that worked well 🫤

[gibsongreen]

All the code changes look good to me and I really like the hints at the app-level!

I also tried clicking on the lock and agree about the tooltip, but got used to it so I’m for whichever path forward works best.

The other icon suggestion was in a followup effort to possibly update the < > to <API>. As long as the width works out I think it would add a lot of clarity.

[cshanahan1]

This looks good! Is this not complete for all plugins yet? I don't see hints for aperture photometry

[kecnry]

This PR only brings to the data-menu. Previous PRs have exposed hints for all plugins with public APIs (aperture photometry is not one of those yet).