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

remove default values from docs #1419

Merged
merged 3 commits into from
Sep 23, 2024

Conversation

braingram
Copy link
Collaborator

@braingram braingram commented Sep 23, 2024

This PR removes the default "maker_utils" values from the examples on the datamodels docs page.
Here's the current page:
https://roman-pipeline.readthedocs.io/en/latest/roman/datamodels/models.html#working-with-models
and the page with this PR:
https://roman-pipeline--1419.org.readthedocs.build/en/1419/roman/datamodels/models.html#working-with-models

A minor fix to the warning message is also included (replacing the non-existent create_wfi_image with mk_datamodel).

This PR is required for spacetelescope/roman_datamodels#388 (which is required for spacetelescope/rad#448).

As this only changes docs (which are tested in the unit tests) regression tests were not run.

Checklist

  • for a public change, added a towncrier news fragment in changes/

    echo "changed something" > changes/<PR#>.<changetype>.rst

    • changes/<PR#>.general.rst: infrastructure or miscellaneous change
    • changes/<PR#>.docs.rst
    • changes/<PR#>.stpipe.rst
    • changes/<PR#>.associations.rst
    • changes/<PR#>.scripts.rst
    • changes/<PR#>.mosaic_pipeline.rst
    • changes/<PR#>.patch_match.rst

    steps

    • changes/<PR#>.dq_init.rst
    • changes/<PR#>.saturation.rst
    • changes/<PR#>.refpix.rst
    • changes/<PR#>.linearity.rst
    • changes/<PR#>.dark_current.rst
    • changes/<PR#>.jump_detection.rst
    • changes/<PR#>.ramp_fitting.rst
    • changes/<PR#>.assign_wcs.rst
    • changes/<PR#>.flatfield.rst
    • changes/<PR#>.photom.rst
    • changes/<PR#>.flux.rst
    • changes/<PR#>.source_detection.rst
    • changes/<PR#>.tweakreg.rst
    • changes/<PR#>.skymatch.rst
    • changes/<PR#>.outlier_detection.rst
    • changes/<PR#>.resample.rst
    • changes/<PR#>.source_catalog.rst
  • updated relevant tests

  • updated relevant documentation

  • updated relevant milestone(s)

  • added relevant label(s)

  • ran regression tests, post a link to the Jenkins job below. How to run regression tests on a PR

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 23, 2024
@braingram braingram marked this pull request as ready for review September 23, 2024 15:01
@braingram braingram requested a review from a team as a code owner September 23, 2024 15:01
@braingram braingram requested a review from schlafly September 23, 2024 15:01
Copy link

codecov bot commented Sep 23, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 78.67%. Comparing base (cb99fba) to head (da8ecf5).
Report is 264 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1419   +/-   ##
=======================================
  Coverage   78.67%   78.67%           
=======================================
  Files         117      117           
  Lines        7728     7728           
=======================================
  Hits         6080     6080           
  Misses       1648     1648           
Flag Coverage Δ *Carryforward flag
nightly 62.26% <ø> (ø) Carriedforward from cb99fba

*This pull request uses carry forward flags. Click here to find out more.

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

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.

Looks good to me. Just checking: the change from wcsinfo to instrument was just to include more interesting output in the docs than a lot of large negative numbers and dummy information?

@braingram
Copy link
Collaborator Author

Looks good to me. Just checking: the change from wcsinfo to instrument was just to include more interesting output in the docs than a lot of large negative numbers and dummy information?

Exactly!

@braingram braingram merged commit 574d9ae into spacetelescope:main Sep 23, 2024
31 checks passed
@braingram braingram deleted the default_filename branch September 23, 2024 15:34
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants