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 schema_editor #352

Merged
merged 4 commits into from
Nov 4, 2024

Conversation

braingram
Copy link
Collaborator

@braingram braingram commented Oct 31, 2024

This PR adds a UserWarning if the schema_editor submodule is imported.

spacetelescope/jwst#8909 removed its use in jwst

before merging this PR I'll make an issue to track the removal of schema_editor. I'm not sure if this qualifies as "public API" (since it's undocumented and untested in this package) so I'm ok removing it in the next minor version (so it's not picked up by current jwst releases).

Regression tests running at: https://github.com/spacetelescope/RegressionTests/actions/runs/11632063641

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 Oct 31, 2024

Codecov Report

Attention: Patch coverage is 33.33333% with 2 lines in your changes missing coverage. Please review.

Project coverage is 67.51%. Comparing base (fd6be8d) to head (0d9f0b4).
Report is 9 commits behind head on main.

Files with missing lines Patch % Lines
src/stdatamodels/jwst/datamodels/schema_editor.py 0.00% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #352      +/-   ##
==========================================
+ Coverage   66.55%   67.51%   +0.96%     
==========================================
  Files         102      114      +12     
  Lines        5456     5913     +457     
==========================================
+ Hits         3631     3992     +361     
- Misses       1825     1921      +96     

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

@braingram braingram force-pushed the deprecate_schema_editor branch 2 times, most recently from 973b130 to 91cd3fa Compare October 31, 2024 18:48
@braingram braingram marked this pull request as ready for review November 1, 2024 13:58
@braingram braingram requested a review from a team as a code owner November 1, 2024 13:58
Copy link
Collaborator

@tapastro tapastro left a comment

Choose a reason for hiding this comment

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

👍

@braingram braingram merged commit 68116df into spacetelescope:main Nov 4, 2024
20 of 21 checks passed
@braingram braingram deleted the deprecate_schema_editor branch November 4, 2024 14:19
@braingram braingram mentioned this pull request Nov 4, 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

Successfully merging this pull request may close these issues.

2 participants