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

Add schema types description to docs (and misc cleanup) #338

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

braingram
Copy link
Collaborator

@braingram braingram commented Oct 22, 2024

This is far from a complete cleanup but addresses a few docs issues:

I also included a test that checks data model schemas to verify they either reference:

  • referencefile.schema (for reference file schemas)
  • core.schema (for data model schemas)

There are 2 exceptions (hard-coded in the test):

I think these both define extra extensions so are sort of partial datamodels. Perhaps this is worth an issue to document that these are different. It may make sense to add another category to the documentation.

Link to updated docs: https://stdatamodels--338.org.readthedocs.build/en/338/jwst/datamodels/schemas.html

As this touches no code (outside of the added unit test) no regression tests were run.

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 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.55%. Comparing base (fd6be8d) to head (a181f4a).
Report is 6 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #338   +/-   ##
=======================================
  Coverage   66.55%   66.55%           
=======================================
  Files         102      102           
  Lines        5456     5457    +1     
=======================================
+ Hits         3631     3632    +1     
  Misses       1825     1825           

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

@braingram braingram marked this pull request as ready for review October 22, 2024 19:35
@braingram braingram requested a review from a team as a code owner October 22, 2024 19:35
@braingram braingram changed the title General docs cleanup Add schema types description to docs (and misc cleanup) Oct 22, 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.

1 participant