DOC: Complete API for firstframe (#10411)

Author: pllim

docs/jwst/firstframe/api_ref.rst

@@ -0,0 +1,15 @@
+===
+API
+===
+
+Public Step API
+===============
+
+.. automodapi:: jwst.firstframe.firstframe_step
+   :no-inheritance-diagram:
+
+Complete Developer API
+======================
+
+.. automodapi:: jwst.firstframe.firstframe_sub
+   :no-inheritance-diagram:

docs/jwst/firstframe/arguments.rst

@@ -4,11 +4,11 @@ Step Arguments
 The ``firstframe`` step has the following step-specific arguments.
 
 ``--bright_use_group1`` (boolean, default=True)
-    If True, setting the group 1 groupdq to DO_NOT_USE will not be done
+    If True, setting the group 1 ``groupdq`` to DO_NOT_USE will not be done
     for pixels that have the saturation flag set for group 3.
     This will allow a slope to be determined for pixels that saturate in group 3.
     This change in flagging will only impact pixels that saturate in group 3, the behavior
     for all other pixels will be unchanged.
     The ``bright_use_group1`` flag can be set for all data, only data/pixels that saturate
     in group 3 will see a difference in behavior. These pixels will be marked with
-    the FLUX_ESTIMATED DQ flag in the pixeldq image.
+    the FLUX_ESTIMATED DQ flag in the ``pixeldq`` image.

docs/jwst/firstframe/description.rst

@@ -1,11 +1,13 @@
 Description
 ===========
 
-:Class: `jwst.firstframe.FirstFrameStep`
+:Class: `jwst.firstframe.firstframe_step.FirstFrameStep`
 :Alias: firstframe
 
-The ``firstframe`` step has been deprecated and will be removed
-in a future release. Flagging the first group  has been added to the RSCD step.
+.. warning::
+    The ``firstframe`` step has been deprecated and will be removed
+    in a future release. Flagging the first group  has been added to
+    the :ref:`RSCD step <rscd_step>`.
 
 The MIRI first frame correction step flags the first group in every integration
 as bad (the "DO_NOT_USE" data quality flag is added to the GROUPDQ array), but

docs/jwst/firstframe/index.rst

@@ -4,10 +4,14 @@
 First Frame Correction
 ======================
 
+.. warning::
+    The ``firstframe`` step has been deprecated and will be removed
+    in a future release. Flagging the first group  has been added to
+    the :ref:`RSCD step <rscd_step>`.
+
 .. toctree::
    :maxdepth: 2
 
    description.rst
    arguments.rst
-
-.. automodapi:: jwst.firstframe
+   api_ref.rst

jwst/firstframe/firstframe_step.py

@@ -1,3 +1,5 @@
+"""Set data quality flag of first group in MIRI data."""
+
 import logging
 import warnings
 

jwst/firstframe/firstframe_sub.py

@@ -21,15 +21,15 @@ def do_correction(output, bright_use_group1=False):
 
     Parameters
     ----------
-    output : DataModel
+    output : `~stdatamodels.jwst.datamodels.JwstDataModel`
         Science data to be corrected
     bright_use_group1 : bool
         If True, setting first group data quality flag to DO_NOT_USE will not be
         done for pixels that have the saturation flag set for group 3.
 
     Returns
     -------
-    output : DataModel
+    output : `~stdatamodels.jwst.datamodels.JwstDataModel`
         Firstframe-corrected science data
     """
     # Save some data params for easy use later