Cherry-picking from branch 15554. All to numpydoc. Conflicts resolved.

Author: WERKSQUAD

python/lsst/pipe/tasks/characterizeImage.py

@@ -246,6 +246,8 @@ class CharacterizeImageTask(pipeBase.CmdLineTask):
     measure:
         - `bool`; if True display image and sources after final measurement
 
+    Examples
+    --------
     For example, put something like:
 
     .. code-block:: none

python/lsst/pipe/tasks/coaddInputRecorder.py

@@ -79,6 +79,18 @@ class CoaddTempExpInputRecorder:
     """
 
     def __init__(self, task, visitId, num=0):
+        """Constructor
+
+        Parameters
+        ----------
+        task :
+            The CoaddInputRecorderTask that is utilising us
+        visitId :
+            Identifier (integer) for the visit
+        num :
+            Number of CCDs for this visit that overlap this
+            patch (for reserving memory)
+        """
         self.task = task
         self.coaddInputs = self.task.makeCoaddInputs()
         self.coaddInputs.visits.reserve(1)

python/lsst/pipe/tasks/colorterms.py

@@ -109,6 +109,8 @@ class ColortermDict(Config):
     ColortermDict(data=dataDict)
     where dataDict is a Python dict of filterName: Colorterm
 
+    Examples
+    --------
     For example:
 
     .. code-block:: none
@@ -143,6 +145,9 @@ class ColortermLibrary(Config):
     ColortermLibrary(data=dataDict)
     where dataDict is a Python dict of catalog_name_or_glob: ColortermDict
 
+    Examples
+    --------
+
     .. code-block:: none
 
         For example:
@@ -153,8 +158,8 @@ class ColortermLibrary(Config):
                     ...
                 }),
                 "sdss": ColortermDict(data={
-                    'g':Colorterm(primary="g", secondary="r", c0=-0.00816446, c1=-0.08366937, c2=-0.00726883),
-                    'r':Colorterm(primary="r", secondary="i", c0= 0.00231810, c1= 0.01284177, c2=-0.03068248),
+                    'g':    Colorterm(primary="g", secondary="r", c0=-0.00816446, c1=-0.08366937, c2=-0.00726883),
+                    'r':    Colorterm(primary="r", secondary="i", c0= 0.00231810, c1= 0.01284177, c2=-0.03068248),
                     ...
                 }),
             })

python/lsst/pipe/tasks/dcrAssembleCoadd.py

@@ -337,7 +337,6 @@ def run(self, skyInfo, tempExpRefList, imageScalerList, weightList,
             The weight to give each input exposure in the coadd
         supplementaryData : `lsst.pipe.base.Struct`
             Result struct returned by ``makeSupplementaryData`` with components:
-
             - ``templateCoadd``: coadded exposure (`lsst.afw.image.Exposure`)
 
         Returns

python/lsst/pipe/tasks/exampleStatsTasks.py

@@ -70,6 +70,12 @@ class ExampleSigmaClippedStatsTask(pipeBase.Task):
     _DefaultName = "exampleSigmaClippedStats"
 
     def __init__(self, *args, **kwargs):
+        """Construct an ExampleSigmaClippedStatsTask
+
+        The init method may compute anything that that does not require data.
+        In this case we create a statistics control object using the config
+        (which cannot change once the task is created).
+        """
         pipeBase.Task.__init__(self, *args, **kwargs)
 
         self._badPixelMask = afwImage.Mask.getPlaneBitMask(self.config.badMaskPlanes)

python/lsst/pipe/tasks/imageDifference.py

@@ -49,7 +49,6 @@
 __all__ = ('ImageDifferenceConfig', 'ImageDifferenceTaskRunner',
            'Winter2013ImageDifferenceConfig', 'Winter2013ImageDifferenceTask')
 
-
 class ImageDifferenceConfig(pexConfig.Config):
     """Config for ImageDifferenceTask
     """
@@ -873,7 +872,6 @@ def setDefaults(self):
         ImageDifferenceConfig.setDefaults(self)
         self.getTemplate.retarget(GetCalexpAsTemplateTask)
 
-
 class Winter2013ImageDifferenceTask(ImageDifferenceTask):
     """Image difference Task used in the Winter 2013 data challege.
     Enables testing the effects of registration shifts and scatter.

python/lsst/pipe/tasks/makeCoaddTempExp.py

@@ -179,6 +179,9 @@ class MakeCoaddTempExpTask(CoaddBaseTask):
     ```config.warpAndPsfMatch.psfMatch.kernel['AL']``` . Each item in the list is formatted as:
     Problem: Explanation. Solution
 
+    Examples
+    --------
+
     Troublshooting PSF-Matching Configuration:
 
     - Matched PSFs look boxy: The matching kernel is too small. _Increase the matching kernel size.

python/lsst/pipe/tasks/multiBand.py

@@ -164,6 +164,9 @@ class DetectCoaddSourcesTask(CmdLineTask):
     Notes
     -----
 
+    Examples
+    --------
+
     DetectCoaddSourcesTask is meant to be run after assembling a coadded image in a given band. The purpose of
     the task is to update the background, detect all sources in a single band and generate a set of parent
     footprints. Subsequent tasks in the multi-band processing procedure will merge sources across bands and,
@@ -664,6 +667,8 @@ class MeasureMergedCoaddSourcesTask(CmdLineTask):
     MeasureMergedCoaddSourcesTask has no debug variables of its own because it delegates all the work to
     the various sub-tasks. See the documetation for individual sub-tasks for more information.
 
+    Examples
+    --------
     After MeasureMergedCoaddSourcesTask has been run on multiple coadds, we have a set of per-band catalogs.
     The next stage in the multi-band processing procedure will merge these measurements into a suitable
     catalog for driving forced photometry.

python/lsst/pipe/tasks/repair.py

@@ -82,6 +82,8 @@ class RepairTask(pipeBase.Task):
     displayCR :
         If True, display the exposure on ds9's frame 1 and overlay bounding boxes around detects CRs.
 
+    Examples
+    --------
     To investigate the pipe_tasks_repair_Debug, put something like
 
     .. code-block :: none