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

RCAL-806: FY24 Datamodels Document Review #437

Merged
merged 7 commits into from
Dec 3, 2024

Conversation

PaulHuwe
Copy link
Collaborator

Resolves RCAL-806

Closes #386 #341

This PR updates the documentation to match the present code version.

Tasks

  • Update or add relevant roman_datamodels tests.
  • Update relevant docstrings and / or docs/ page.
  • Does this PR change any API used downstream? (If not, label with no-changelog-entry-needed.)
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

@PaulHuwe PaulHuwe marked this pull request as ready for review November 29, 2024 06:32
@PaulHuwe PaulHuwe requested a review from a team as a code owner November 29, 2024 06:32
Copy link
Collaborator

@schlafly schlafly 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 good to me. IIRC Brett just removed assignment validation from roman_datamodels so I don't think we should document that bit.

Copy link

codecov bot commented Dec 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.34%. Comparing base (087a60d) to head (e44083e).
Report is 84 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #437      +/-   ##
==========================================
- Coverage   97.56%   97.34%   -0.22%     
==========================================
  Files          30       37       +7     
  Lines        2788     3317     +529     
==========================================
+ Hits         2720     3229     +509     
- Misses         68       88      +20     

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

Copy link
Collaborator

@braingram braingram left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks for all the fixes.

@PaulHuwe PaulHuwe merged commit a672cb3 into spacetelescope:main Dec 3, 2024
19 of 20 checks passed
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.

FY24 Document Review
3 participants