Merge pull request #832 from lsst/tickets/DM-22287

DM-22287: Clean up inheritDoc decorator usage
lsst · Sep 15, 2023 · f2f5851 · f2f5851
2 parents 80d919d + b73c9b4
commit f2f5851
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 9 deletions.
diff --git a/python/lsst/pipe/tasks/assembleChi2Coadd.py b/python/lsst/pipe/tasks/assembleChi2Coadd.py
@@ -32,7 +32,6 @@
 import lsst.pex.config as pexConfig
 import lsst.pipe.base as pipeBase
 import lsst.pipe.base.connectionTypes as cT
-import lsst.utils as utils
 
 
 log = logging.getLogger(__name__)
@@ -183,7 +182,6 @@ def combinedMasks(self, masks: list[afwImage.MaskX]) -> afwImage.MaskX:
         result.array[:] = mask
         return result
 
-    @utils.inheritDoc(pipeBase.PipelineTask)
     def runQuantum(self, butlerQC, inputRefs, outputRefs):
         inputs = butlerQC.get(inputRefs)
         outputs = self.run(**inputs)

diff --git a/python/lsst/pipe/tasks/assembleCoadd.py b/python/lsst/pipe/tasks/assembleCoadd.py
@@ -407,7 +407,6 @@ def __init__(self, *args, **kwargs):
 
         self.warpType = self.config.warpType
 
-    @utils.inheritDoc(pipeBase.PipelineTask)
     def runQuantum(self, butlerQC, inputRefs, outputRefs):
         inputData = butlerQC.get(inputRefs)
 
@@ -1500,7 +1499,9 @@ def _noTemplateMessage(self, warpType):
     @timeMethod
     def run(self, skyInfo, tempExpRefList, imageScalerList, weightList,
             supplementaryData):
-        """Assemble the coadd.
+        """Notes
+        -----
+        Assemble the coadd.
 
         Find artifacts and apply them to the warps' masks creating a list of
         alternative masks with a new "CLIPPED" plane and updated "NO_DATA"

diff --git a/python/lsst/pipe/tasks/makeWarp.py b/python/lsst/pipe/tasks/makeWarp.py
@@ -317,9 +317,13 @@ def __init__(self, **kwargs):
 
     @utils.inheritDoc(pipeBase.PipelineTask)
     def runQuantum(self, butlerQC, inputRefs, outputRefs):
-        # Obtain the list of input detectors from calExpList.  Sort them by
-        # detector order (to ensure reproducibility).  Then ensure all input
-        # lists are in the same sorted detector order.
+        # Docstring to be augmented with info from PipelineTask.runQuantum
+        """Notes
+        -----
+        Obtain the list of input detectors from calExpList.  Sort them by
+        detector order (to ensure reproducibility).  Then ensure all input
+        lists are in the same sorted detector order.
+        """
         detectorOrder = [ref.datasetRef.dataId['detector'] for ref in inputRefs.calExpList]
         detectorOrder.sort()
         inputRefs = reorderRefs(inputRefs, detectorOrder, dataIdKey='detector')

diff --git a/python/lsst/pipe/tasks/selectImages.py b/python/lsst/pipe/tasks/selectImages.py
@@ -25,7 +25,6 @@
 
 import numpy as np
 import lsst.sphgeom
-import lsst.utils as utils
 import lsst.pex.config as pexConfig
 import lsst.pex.exceptions as pexExceptions
 import lsst.geom as geom
@@ -635,7 +634,6 @@ class BestSeeingQuantileSelectVisitsTask(BestSeeingSelectVisitsTask):
     ConfigClass = BestSeeingQuantileSelectVisitsConfig
     _DefaultName = 'bestSeeingQuantileSelectVisits'
 
-    @utils.inheritDoc(BestSeeingSelectVisitsTask)
     def run(self, visitSummaries, skyMap, dataId):
         if self.config.doConfirmOverlap:
             patchPolygon = self.makePatchPolygon(skyMap, dataId)