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

update docs to reflect lack of assignment validation #1504

Merged
merged 4 commits into from
Nov 22, 2024

Conversation

braingram
Copy link
Collaborator

@braingram braingram commented Nov 8, 2024

Requires spacetelescope/roman_datamodels#417 since that PR is approved I'm opening this PR for review.

spacetelescope/roman_datamodels#417 removes validation on assignment for roman_datamodels. This PR updates the romancal docs to reflect that attribute assignment no longer triggers validation.

I suggest we merge this PR right after merging spacetelescope/roman_datamodels#417 since the doctest updated in this PR will otherwise start failing for devdeps and regtest runs with other roman_datamodels PRs.

Tasks

  • request a review from someone specific, to avoid making the maintainers review every PR
  • add a build milestone, i.e. 24Q4_B15 (use the latest build if not sure)
  • Does this PR change user-facing code / API? (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)
    • update or add relevant tests
    • update relevant docstrings and / or docs/ page
    • start a regression test and include a link to the running job (click here for instructions)
      • Do truth files need to be updated ("okified")?
        • after the reviewer has approved these changes, run okify_regtests to update the truth files
  • if a JIRA ticket exists, make sure it is resolved properly
news fragment change types...
  • 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

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Nov 8, 2024
Copy link

codecov bot commented Nov 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 76.68%. Comparing base (78c7dc4) to head (df0ca76).
Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1504   +/-   ##
=======================================
  Coverage   76.68%   76.68%           
=======================================
  Files         120      120           
  Lines        7831     7831           
=======================================
  Hits         6005     6005           
  Misses       1826     1826           

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


🚨 Try these New Features:

@braingram braingram force-pushed the no_assignment_validation branch 2 times, most recently from 600b05e to 968c548 Compare November 20, 2024 14:15
@github-actions github-actions bot added the dependencies Pull requests that update a dependency file label Nov 20, 2024
@braingram braingram force-pushed the no_assignment_validation branch from 3c13345 to bb2f30b Compare November 22, 2024 18:15
@braingram braingram marked this pull request as ready for review November 22, 2024 18:17
@braingram braingram requested a review from a team as a code owner November 22, 2024 18:17
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.

Thanks!

@braingram braingram enabled auto-merge November 22, 2024 18:44
@braingram braingram merged commit 825ed17 into spacetelescope:main Nov 22, 2024
27 checks passed
@braingram braingram deleted the no_assignment_validation branch November 22, 2024 19:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants