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

API hints #133

Merged
merged 3 commits into from
Oct 17, 2024
Merged

API hints #133

merged 3 commits into from
Oct 17, 2024

Conversation

kecnry
Copy link
Member

@kecnry kecnry commented Aug 21, 2024

Implement API hints across all plugins.

Requires spacetelescope/jdaviz#3159 to be merged and included in the 4.0 release of jdaviz.

Waiting for: jdaviz 4.0

@kecnry kecnry added this to the 0.5.0 milestone Aug 21, 2024
Copy link

codecov bot commented Aug 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.20%. Comparing base (7b78df5) to head (d57a839).
Report is 38 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #133      +/-   ##
==========================================
- Coverage   93.92%   91.20%   -2.73%     
==========================================
  Files          37       41       +4     
  Lines        1598     2149     +551     
==========================================
+ Hits         1501     1960     +459     
- Misses         97      189      +92     

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

@kecnry kecnry added the waiting-on-jdaviz-release PR requires a release from jdaviz before updating the pin label Aug 21, 2024
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.

This looks great. I'm approving, with the caveat of the one comment below.

Comment on lines +242 to +250
{{ api_hints_enabled ?
'plg.query_for_ephemeris()'
:
'Query'
}}
Copy link
Contributor

Choose a reason for hiding this comment

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

You got the query_for_ephemeris method for this portion of the plugin, but not the name/RA/Dec/radius fields above:

Screenshot 2024-08-21 at 14 44 28

Copy link
Member Author

Choose a reason for hiding this comment

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

yep, you didn't expose those to the API in #127 😝 Do you want me to add them here?

Copy link
Member Author

Choose a reason for hiding this comment

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

these are now exposed in the API and hints added in this PR.

@kecnry kecnry removed the waiting-on-jdaviz-release PR requires a release from jdaviz before updating the pin label Oct 17, 2024
@kecnry kecnry marked this pull request as ready for review October 17, 2024 16:21
@kecnry kecnry merged commit 5a8dc86 into spacetelescope:main Oct 17, 2024
12 of 14 checks passed
@kecnry kecnry deleted the api-hints branch October 17, 2024 16:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants