Update docs for new keywords

spacetelescope · Mar 7, 2025 · 7f8018c · 7f8018c
1 parent 51f067d
commit 7f8018c
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 4 deletions.
diff --git a/docs/jwst/barshadow/description.rst b/docs/jwst/barshadow/description.rst
@@ -54,3 +54,8 @@ Output product
 The output is a new copy of the input `~jwst.datamodels.MultiSlitModel`, with the
 corrections applied to the slit data arrays. The 2-D correction array for each slit
 is also added to the datamodel in the "BARSHADOW" extension.
+
+Upon successful completion of the step, the status keyword "S_BARSHA"
+in the primary header is set to "COMPLETE".  For each SCI extension, the "BARSHDW"
+keyword is set to True if the slit was barshadow corrected (it is an extended
+source) or False if it was not corrected (it is a point source).
diff --git a/docs/jwst/pathloss/description.rst b/docs/jwst/pathloss/description.rst
@@ -109,6 +109,12 @@ Like for the point source case, the 1-d arrays of pathloss correction and wavele
 are used to interpolate the correction for each pixel in the science data, using the
 wavelength of each pixel to interpolate into the pathloss correction array.
 
+Upon successful completion of the step, the status keyword "S_PTHLOS"
+in the primary header is set to "COMPLETE".  For each SCI extension, the "PTHLOSS"
+keyword is set to "POINT" if the point source correction type was applied to the
+slit data. It is set to "UNIFORM" if the uniform correction type was applied.
+The keyword is not set if no correction was applied.
+
 MIRI LRS
 ++++++++
 The algorithm for MIRI LRS mode is largely the same as that for NIRSpec described

diff --git a/docs/jwst/wavecorr/description.rst b/docs/jwst/wavecorr/description.rst
@@ -9,6 +9,11 @@ The wavelength correction (``wavecorr``) step in the
 assignments for NIRSpec fixed-slit (FS) and MOS point sources that are
 known to be off center (in the dispersion direction) in their slit.
 
+Upon successful completion of the step, the status keyword "S_WAVCOR"
+in the primary header is set to "COMPLETE".  For each SCI extension, the "WAVECOR"
+keyword is set to True if the slit was wavelength corrected (it is a point
+source) or False if it was not corrected (it is a point source).
+
 NIRSpec MOS
 -----------
 For NIRSpec MOS exposures (EXP_TYPE="NRS_MSASPEC"), wavelength
@@ -47,7 +52,4 @@ target coordinates and aperture reference point during the
 :ref:`extract_2d <extract_2d_step>` step. This estimated position (in the 
 dispersion direction) is used in the same manner as described above
 for MOS slitlets to update the slit WCS and compute corrected wavelengths
-for the primary slit only. 
-
-Upon successful completion of the step, the status keyword "S_WAVCOR"
-is set to "COMPLETE".
+for the primary slit only.