From b73c9b4faa0c14241ac3ff222eef539074ff569c Mon Sep 17 00:00:00 2001 From: Tim Jenness Date: Thu, 14 Sep 2023 13:29:29 -0700 Subject: [PATCH] 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')