spacetelescope / stcal

https://stcal.readthedocs.io/en/latest/
Other
10 stars 32 forks source link

JP-3525: Merge jump and ramp_fitting docs content with jwst docs #240

Closed hbushouse closed 8 months ago

hbushouse commented 9 months ago

This PR partially resolves JP-3525 by making updates to the docs stored in stcal, in order to merge and sort out the info between the docs in jwst and stcal. Related updates will be made in jwst/docs. The vast majority of the high-level step information, especially those things that are JWST-specific, is being moved to jwst/docs, while the stcal/docs retain only low-level algorithmic information.

Checklist

codecov[bot] commented 9 months ago

Codecov Report

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

Comparison is base (fd2d6ce) 85.98% compared to head (bc5f5e8) 85.98%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #240 +/- ## ======================================= Coverage 85.98% 85.98% ======================================= Files 35 35 Lines 6542 6542 ======================================= Hits 5625 5625 Misses 917 917 ```

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

hbushouse commented 9 months ago

I understand the hierarchy and linking of the documentation for the different repos is difficult, but much of the documentation being removed from the STCAL repo is about how ramp fitting works in STCAL. In the future, if someone wants to use STCAL for a new telescope, they need to know the information in the documentation being deleted.

I thought about this some more and decided to move a lot more of the basic content from jwst to stcal, with a lot more links/references from the jwst side.