DOC: Complete API for imprint (#10435)

Author: pllim

docs/jwst/imprint/api_ref.rst

@@ -0,0 +1,14 @@
+===
+API
+===
+
+Public Step API
+===============
+
+.. automodapi:: jwst.imprint.imprint_step
+   :no-inheritance-diagram:
+
+Complete Developer API
+======================
+
+N/A

docs/jwst/imprint/description.rst

@@ -1,7 +1,7 @@
 Description
 ===========
 
-:Class: `jwst.imprint.ImprintStep`
+:Class: `jwst.imprint.imprint_step.ImprintStep`
 :Alias: imprint
 
 The NIRSpec MSA imprint subtraction step removes patterns created in NIRSpec
@@ -29,7 +29,7 @@ unaltered.
 When subtracting the imprint data model from the target data model,
 the SCI data array of the imprint exposure is subtracted from the SCI array
 of the target exposure, and the DQ arrays of the two exposures are combined using
-a bitwise logical OR operation. The error and variance arrays are not
+a bitwise OR operation. The error and variance arrays are not
 currently used or modified.
 
 Step Arguments

docs/jwst/imprint/index.rst

@@ -8,5 +8,4 @@ Imprint Subtraction
    :maxdepth: 2
 
    description.rst
-
-.. automodapi:: jwst.imprint
+   api_ref.rst

jwst/imprint/imprint_step.py

@@ -1,3 +1,5 @@
+"""Remove NIRSpec MSA imprint structure from an exposure."""
+
 import logging
 
 from stdatamodels.jwst import datamodels
@@ -45,14 +47,14 @@ def process(self, input_data, imprint):
 
         Parameters
         ----------
-        input_data : `~stdatamodels.jwst.datamodels.JwstDataModel` or str
+        input_data : str or `~stdatamodels.jwst.datamodels.JwstDataModel`
             Input exposure to be corrected.
         imprint : list of str or `~stdatamodels.jwst.datamodels.JwstDataModel`
             Imprint exposures associated with the input.
 
         Returns
         -------
-        DataModel
+        `~stdatamodels.jwst.datamodels.JwstDataModel`
             The imprint subtracted exposure.
         """
         # Open the input science image and get its dither pattern position number