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

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

Merged
merged 4 commits into from
Feb 14, 2024

Conversation

hbushouse
Copy link
Collaborator

@hbushouse hbushouse commented Feb 1, 2024

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

  • added entry in CHANGES.rst (either in Bug Fixes or Changes to API)
  • updated relevant tests
  • updated relevant documentation
  • updated relevant milestone(s)
  • added relevant label(s)

@hbushouse hbushouse requested a review from a team as a code owner February 1, 2024 16:23
@github-actions github-actions bot added documentation Improvements or additions to documentation ramp_fitting labels Feb 1, 2024
Copy link

codecov bot commented Feb 1, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

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

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

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

Copy link
Collaborator

@kmacdonald-stsci kmacdonald-stsci left a comment

Choose a reason for hiding this comment

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

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.

@hbushouse
Copy link
Collaborator Author

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.

@github-actions github-actions bot added the jump label Feb 14, 2024
@hbushouse hbushouse changed the title JP-3525: Merge ramp_fitting docs content with jwst docs JP-3525: Merge jump and ramp_fitting docs content with jwst docs Feb 14, 2024
@hbushouse hbushouse merged commit 5cdca94 into spacetelescope:main Feb 14, 2024
25 checks passed
@hbushouse hbushouse deleted the jp-3525 branch February 14, 2024 16:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation jump ramp_fitting
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants