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

deprecate nlow nhigh, fix incorrect spec values in docs #8603

Merged
merged 6 commits into from
Jun 26, 2024

Conversation

braingram
Copy link
Collaborator

@braingram braingram commented Jun 26, 2024

This is a follow-up to #8602 and:

  • adds a deprecation comment to the nlow and nhigh parameters
  • removes nlow and nhigh from the documentation
  • fixes the spec values in the docs

The spec values in the docs do not match the step (see the below linked issue). This PR removes the datatypes and defaults from the "arguments" docs page and adds a link to the spec (which will automatically stay up-to-date with the step).

Link to the updated docs: https://jwst-pipeline--8603.org.readthedocs.build/en/8603/jwst/outlier_detection/arguments.html

Fixes #8599

Checklist for PR authors (skip items if you don't have permissions or they are not applicable)

  • added entry in CHANGES.rst within the relevant release section
  • updated or added relevant tests
  • updated relevant documentation
  • added relevant milestone
  • added relevant label(s)
  • ran regression tests, post a link to the Jenkins job below.
    How to run regression tests on a PR
  • All comments are resolved
  • Make sure the JIRA ticket is resolved properly

@braingram braingram requested a review from a team as a code owner June 26, 2024 13:00
@hbushouse hbushouse added this to the Build 11.0 milestone Jun 26, 2024
Copy link

codecov bot commented Jun 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.56%. Comparing base (23fb5cd) to head (8ec9813).

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #8603      +/-   ##
==========================================
+ Coverage   59.54%   59.56%   +0.02%     
==========================================
  Files         391      391              
  Lines       39292    39285       -7     
==========================================
+ Hits        23396    23402       +6     
+ Misses      15896    15883      -13     

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

@braingram braingram force-pushed the deprecate_nlow_nhigh branch from c402d27 to 56ad26c Compare June 26, 2024 15:03
Copy link
Collaborator

@hbushouse hbushouse left a comment

Choose a reason for hiding this comment

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

One final (I hope) comment.

@hbushouse hbushouse merged commit 90f4d57 into spacetelescope:master Jun 26, 2024
27 checks passed
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.

Outlier detection arguments documentation out-of-date
2 participants