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

Remove signature from wrapper in API hints #3435

Merged
merged 2 commits into from
Feb 13, 2025

Conversation

pllim
Copy link
Contributor

@pllim pllim commented Feb 12, 2025

Description

This pull request is a follow-up of unreleased #3384

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)? 🐱

@pllim pllim added bug Something isn't working documentation Explanation of code and concepts api API change no-changelog-entry-needed changelog bot directive Affects-dev changelog bot directive labels Feb 12, 2025
@pllim pllim added this to the 4.2 milestone Feb 12, 2025
Copy link

codecov bot commented Feb 12, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.54%. Comparing base (51a7cd3) to head (cdfd69b).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3435   +/-   ##
=======================================
  Coverage   87.53%   87.54%           
=======================================
  Files         128      128           
  Lines       19963    19974   +11     
=======================================
+ Hits        17475    17486   +11     
  Misses       2488     2488           

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

@pllim pllim marked this pull request as ready for review February 12, 2025 19:08
@kecnry
Copy link
Member

kecnry commented Feb 12, 2025

this now includes self in the signature for these wrapped methods, can we avoid that?

@pllim
Copy link
Contributor Author

pllim commented Feb 12, 2025

Good catch! I added more logic to exclude it. Does it look better now?

Copy link
Member

@kecnry kecnry left a comment

Choose a reason for hiding this comment

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

Thanks!

@pllim
Copy link
Contributor Author

pllim commented Feb 12, 2025

Does this need a second review? Thanks!

@pllim pllim merged commit 4cfa7a1 into spacetelescope:main Feb 13, 2025
21 checks passed
@pllim pllim deleted the plugin-api-no-args-kwargs branch February 13, 2025 15:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Affects-dev changelog bot directive api API change bug Something isn't working documentation Explanation of code and concepts no-changelog-entry-needed changelog bot directive
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants