Skip to content

Commit

Permalink
Add explicit Notes section to additional docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
timj committed Sep 14, 2023
1 parent 2be8d95 commit b73c9b4
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
4 changes: 3 additions & 1 deletion python/lsst/pipe/tasks/assembleCoadd.py
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
10 changes: 7 additions & 3 deletions python/lsst/pipe/tasks/makeWarp.py
Original file line number Diff line number Diff line change
Expand Up @@ -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')
Expand Down

0 comments on commit b73c9b4

Please sign in to comment.