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 or remove extra_fits #295

Open
braingram opened this issue Mar 28, 2024 · 0 comments
Open

Deprecate or remove extra_fits #295

braingram opened this issue Mar 28, 2024 · 0 comments
Milestone

Comments

@braingram
Copy link
Collaborator

As noted in https://jira.stsci.edu/browse/JP-2056 the documentation for extra_fits incorrectly refers to it as _extra_fits:
https://stdatamodels.readthedocs.io/en/latest/jwst/datamodels/models.html#extra-fits-keywords

There are other references to extra_fits:
https://stdatamodels.readthedocs.io/en/latest/search.html?q=extra_fits&check_keywords=yes&area=default

We should consider deprecating extra_fits as part of the "public" API (it appears to only have a single use in jwst):
https://github.com/spacetelescope/jwst/blob/33fd9fa52debf69ccb53aab32ab1073425bc4418/jwst/model_blender/tests/test_blend.py#L127

We should continue to "roundtrip" non-schema fits data but allowing users to arbitrarily update these data while in memory seems dangerous. Any updates can instead use the existing astropy.io.fits API.

Since extra_fits appears in the documentation I suggest we:

  • deprecate it
  • update the documentation
  • remove it in a later major version (I'm milestoneing this issue for 2.0.0)
@braingram braingram added this to the 2.0.0 milestone Mar 28, 2024
@braingram braingram modified the milestones: 2.0.0, 3.0.0 Jun 24, 2024
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

No branches or pull requests

1 participant