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

Deprecate extra_fits #402

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

Conversation

emolter
Copy link
Contributor

@emolter emolter commented Feb 12, 2025

Closes #295

Resolves JP-3886

This PR deprecates direct reading and setting of the extra_fits and _extra_fits attributes of datamodels.

Tasks

  • update or add relevant tests
  • update relevant docstrings and / or docs/ page
  • Does this PR change any API used downstream? (if not, label with no-changelog-entry-needed)
    • write news fragment(s) in changes/: echo "changed something" > changes/<PR#>.<changetype>.rst (see below for change types)
    • run jwst regression tests with this branch installed ("git+https://github.com/<fork>/stdatamodels@<branch>")
news fragment change types...
  • changes/<PR#>.feature.rst: new feature
  • changes/<PR#>.bugfix.rst: fixes an issue
  • changes/<PR#>.doc.rst: documentation change
  • changes/<PR#>.removal.rst: deprecation or removal of public API
  • changes/<PR#>.misc.rst: infrastructure or miscellaneous change

Copy link

codecov bot commented Feb 12, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.15%. Comparing base (4e83608) to head (cb57475).
Report is 4 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #402      +/-   ##
==========================================
- Coverage   78.16%   78.15%   -0.02%     
==========================================
  Files         115      115              
  Lines        5144     5158      +14     
==========================================
+ Hits         4021     4031      +10     
- Misses       1123     1127       +4     

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

@emolter
Copy link
Contributor Author

emolter commented Feb 12, 2025

@braingram I have to admit I've never had to deprecate access to an attribute before, nor deprecate something that is currently used in so many places. Leaving this as draft for now - is this anywhere near what you would have envisioned?

@braingram
Copy link
Collaborator

@braingram I have to admit I've never had to deprecate access to an attribute before, nor deprecate something that is currently used in so many places. Leaving this as draft for now - is this anywhere near what you would have envisioned?

Thanks. Yeah I think this is on the right track. Since we're awaiting feedback I'll defer a detailed look until we've heard back.

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.

Deprecate or remove extra_fits
2 participants