spacetelescope / jwst

Python library for science observations from the James Webb Space Telescope
https://jwst-pipeline.readthedocs.io/en/latest/
Other
570 stars 167 forks source link

Outlier detection arguments documentation out-of-date #8599

Closed braingram closed 4 months ago

braingram commented 4 months ago

https://jwst-pipeline.readthedocs.io/en/latest/jwst/outlier_detection/arguments.html#step-arguments-for-non-ifu-data mentions a default snr: https://github.com/spacetelescope/jwst/blob/29046fc1d12f5175940fb3c0b77ea21cb0957264/docs/jwst/outlier_detection/arguments.rst?plain=1#L39 that does not match the default in the spec: https://github.com/spacetelescope/jwst/blob/29046fc1d12f5175940fb3c0b77ea21cb0957264/jwst/outlier_detection/outlier_detection_step.py#L61 Other parameters are also out-of-date.

Is it necessary to duplicate the default values in the docs? These are already auto-generated for the step spec: https://jwst-pipeline.readthedocs.io/en/latest/api/jwst.outlier_detection.OutlierDetectionStep.html#jwst.outlier_detection.OutlierDetectionStep.spec

I suggest that we remove the default values from the docs that are not auto-generated from the spec.