From 2be8d958abc1e0bcf5e292816b6f92b700c42c08 Mon Sep 17 00:00:00 2001 From: Tim Jenness Date: Thu, 14 Sep 2023 13:29:13 -0700 Subject: [PATCH 1/2] Remove inheritDoc decorator that was not doing anything The docstrings were already being inherited and no additional text was present. --- python/lsst/pipe/tasks/assembleChi2Coadd.py | 2 -- python/lsst/pipe/tasks/assembleCoadd.py | 1 - python/lsst/pipe/tasks/selectImages.py | 2 -- 3 files changed, 5 deletions(-) diff --git a/python/lsst/pipe/tasks/assembleChi2Coadd.py b/python/lsst/pipe/tasks/assembleChi2Coadd.py index a9bc70060..ec4bcbbd9 100644 --- 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 index 30d8f3b02..04b5a8717 100644 --- 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) diff --git a/python/lsst/pipe/tasks/selectImages.py b/python/lsst/pipe/tasks/selectImages.py index 82f2ece67..e125f114c 100644 --- 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) From b73c9b4faa0c14241ac3ff222eef539074ff569c Mon Sep 17 00:00:00 2001 From: Tim Jenness Date: Thu, 14 Sep 2023 13:29:29 -0700 Subject: [PATCH 2/2] Add explicit Notes section to additional docstring --- python/lsst/pipe/tasks/assembleCoadd.py | 4 +++- python/lsst/pipe/tasks/makeWarp.py | 10 +++++++--- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/python/lsst/pipe/tasks/assembleCoadd.py b/python/lsst/pipe/tasks/assembleCoadd.py index 04b5a8717..428cea90d 100644 --- a/python/lsst/pipe/tasks/assembleCoadd.py +++ b/python/lsst/pipe/tasks/assembleCoadd.py @@ -1499,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 index 64a1536d4..a868e0208 100644 --- 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')