Skip to content

DOC: Complete API for white_light#10705

Open
pllim wants to merge 2 commits into
spacetelescope:mainfrom
pllim:dont-walk-towards-white-light
Open

DOC: Complete API for white_light#10705
pllim wants to merge 2 commits into
spacetelescope:mainfrom
pllim:dont-walk-towards-white-light

Conversation

@pllim

@pllim pllim commented Jul 10, 2026

Copy link
Copy Markdown
Collaborator

Towards JP-4107

This PR addresses white_light portion of #9793 . Only touch docs so should not need RT.

On main:

With this patch:

Tasks

  • If you have a specific reviewer in mind, tag them.
  • add a build milestone, i.e. Build 12.0 (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 changelog readme for instructions)
      • if your change breaks step-level or public API (as defined in the docs), also add a changes/<PR#>.breaking.rst news fragment
    • 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

Comment thread docs/jwst/references_general/wavelengthrange_reffile.inc
@pllim
pllim marked this pull request as ready for review July 10, 2026 02:53
@pllim
pllim requested a review from a team July 10, 2026 02:53
@codecov

codecov Bot commented Jul 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.11%. Comparing base (5024ea1) to head (e3d1000).

Additional details and impacted files
@@           Coverage Diff           @@
##             main   #10705   +/-   ##
=======================================
  Coverage   87.11%   87.11%           
=======================================
  Files         374      374           
  Lines       40349    40349           
=======================================
  Hits        35149    35149           
  Misses       5200     5200           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@emolter emolter left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks great, but a question about the expected input types.

It's sorta beyond the scope of this PR but at the same time should be fixed, and this was an opportunity to review the documentation.

Comment thread docs/jwst/white_light/description.rst
Comment thread jwst/white_light/white_light_step.py Outdated
@pllim

pllim commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator Author

expected input types

Looks like you are one of the owners of this step. Just tell me what to change and I will change it. 😸

/jwst/white_light/ @spacetelescope/jwst-pipeline-maintainers @penaguerrero @emolter

@emolter

emolter commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator

Yeah fair enough. I think @melanieclarke will know best though as she implemented TSOMultiSpecModel. I think what is needed is to replace all instances of MultiSpecModel with TSOMultiSpecModel as well as to mention TSOMultiSpecModel in the location in the docs I specified. I don't believe the generic MultiSpecModel is supported anymore but I'm not 100%... can you confirm that Melanie?

@pllim

This comment was marked as resolved.

@pllim
pllim requested a review from melanieclarke July 14, 2026 14:28
@melanieclarke

Copy link
Copy Markdown
Collaborator

Ned is right -- this step only supports TSOMultiSpecModel now. Anywhere it says MultiSpecModel for this step, it should now say TSOMultiSpecModel. Thanks for catching that!

Comment thread jwst/white_light/white_light_step.py Outdated
pllim added 2 commits July 21, 2026 21:05
as requested by Ned Molter and Melanie Clarke
@pllim
pllim force-pushed the dont-walk-towards-white-light branch from 594b0f1 to e3d1000 Compare July 22, 2026 01:21
@pllim

pllim commented Jul 22, 2026

Copy link
Copy Markdown
Collaborator Author

Thanks @emolter and @melanieclarke ! I think I have addressed all comments. Please re-review to make sure I got them right.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants