Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DM-22287: Clean up inheritDoc decorator usage #832

Merged
merged 2 commits into from
Sep 15, 2023
Merged

DM-22287: Clean up inheritDoc decorator usage #832

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2be8d95
Remove inheritDoc decorator that was not doing anything
timj Sep 14, 2023
b73c9b4
Add explicit Notes section to additional docstring
timj Sep 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions python/lsst/pipe/tasks/assembleChi2Coadd.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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__)
Expand Down Expand Up @@ -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)
Expand Down
5 changes: 3 additions & 2 deletions python/lsst/pipe/tasks/assembleCoadd.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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"
Expand Down
10 changes: 7 additions & 3 deletions python/lsst/pipe/tasks/makeWarp.py
View file
Open in desktop
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
2 changes: 0 additions & 2 deletions python/lsst/pipe/tasks/selectImages.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand Down