spacetelescope / stdatamodels

https://stdatamodels.readthedocs.io
Other
5 stars 25 forks source link

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

Closed braingram closed 2 weeks ago

braingram commented 1 month ago

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:

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

news fragment change types... - ``changes/.feature.rst``: new feature - ``changes/.bugfix.rst``: fixes an issue - ``changes/.doc.rst``: documentation change - ``changes/.removal.rst``: deprecation or removal of public API - ``changes/.misc.rst``: infrastructure or miscellaneous change
codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 67.51%. Comparing base (73c887c) to head (46a8519). Report is 6 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #338 +/- ## ======================================= Coverage 67.51% 67.51% ======================================= Files 114 114 Lines 5913 5913 ======================================= Hits 3992 3992 Misses 1921 1921 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.