Manual documentation and __all__ updates following rebase to master.

See ticket comment on details.
lsst · Dec 18, 2018 · e6a5e2a · e6a5e2a
1 parent 8e1ac2d
commit e6a5e2a
Show file tree

Hide file tree

Showing 16 changed files with 23 additions and 31 deletions.
diff --git a/python/lsst/pipe/tasks/imageDifference.py b/python/lsst/pipe/tasks/imageDifference.py
@@ -46,8 +46,8 @@
 FwhmPerSigma = 2 * math.sqrt(2 * math.log(2))
 IqrToSigma = 0.741
 
-__all__ = ('ImageDifferenceConfig', 'ImageDifferenceTaskRunner',
-           'Winter2013ImageDifferenceConfig', 'Winter2013ImageDifferenceTask')
+__all__ = ['ImageDifferenceConfig', 'ImageDifferenceTaskRunner',
+           'Winter2013ImageDifferenceConfig', 'Winter2013ImageDifferenceTask']
 
 class ImageDifferenceConfig(pexConfig.Config):
     """Config for ImageDifferenceTask

diff --git a/python/lsst/pipe/tasks/ingest.py b/python/lsst/pipe/tasks/ingest.py
@@ -12,8 +12,8 @@
 from lsst.pipe.base import Task, InputOnlyArgumentParser
 from lsst.afw.fits import DEFAULT_HDU
 
-__all__ = ('IngestArgumentParser', 'ParseConfig', 'ParseConfig', 'ParseTask', 'RegisterConfig',
-           'RegistryContext', 'RegisterTask', 'IngestConfig', 'IngestTask')
+__all__ = ['IngestArgumentParser', 'ParseConfig', 'ParseConfig', 'ParseTask', 'RegisterConfig',
+           'RegistryContext', 'RegisterTask', 'IngestConfig', 'IngestTask']
 
 
 class IngestArgumentParser(InputOnlyArgumentParser):

diff --git a/python/lsst/pipe/tasks/ingestPgsql.py b/python/lsst/pipe/tasks/ingestPgsql.py
@@ -10,7 +10,7 @@
 except ImportError:
     havePgSql = False
 
-__all__ = ('PgsqlRegistryContext', 'PgsqlRegisterTask', 'PgsqlIngestConfig', 'PgsqlIngestTask')
+__all__ = ['PgsqlRegistryContext', 'PgsqlRegisterTask', 'PgsqlIngestConfig', 'PgsqlIngestTask']
 
 
 class PgsqlRegistryContext(RegistryContext):

diff --git a/python/lsst/pipe/tasks/makeDiscreteSkyMap.py b/python/lsst/pipe/tasks/makeDiscreteSkyMap.py
@@ -30,7 +30,7 @@
 from lsst.skymap import DiscreteSkyMap, BaseSkyMap
 from lsst.pipe.base import ArgumentParser
 
-__all__ = ('MakeDiscreteSkyMapConfig', 'MakeDiscreteSkyMapRunner', 'MakeDiscreteSkyMapTask')
+__all__ = ['MakeDiscreteSkyMapConfig', 'MakeDiscreteSkyMapRunner', 'MakeDiscreteSkyMapTask']
 
 
 class MakeDiscreteSkyMapConfig(pexConfig.Config):

diff --git a/python/lsst/pipe/tasks/makeSkyMap.py b/python/lsst/pipe/tasks/makeSkyMap.py
@@ -27,7 +27,7 @@
 import lsst.pipe.base as pipeBase
 from lsst.skymap import skyMapRegistry
 
-__all__ = ('MakeSkyMapConfig', 'MakeSkyMapRunner', 'MakeSkyMapTask')
+__all__ = ['MakeSkyMapConfig', 'MakeSkyMapRunner', 'MakeSkyMapTask']
 
 
 class MakeSkyMapConfig(pexConfig.Config):

diff --git a/python/lsst/pipe/tasks/matchBackgrounds.py b/python/lsst/pipe/tasks/matchBackgrounds.py
@@ -26,7 +26,7 @@
 import lsst.pipe.base as pipeBase
 import lsstDebug
 
-__all__ = ('MatchBackgroundsConfig', 'MatchBackgroundsTask', 'DataRefMatcher')
+__all__ = ['MatchBackgroundsConfig', 'MatchBackgroundsTask', 'DataRefMatcher']
 
 
 class MatchBackgroundsConfig(pexConfig.Config):

diff --git a/python/lsst/pipe/tasks/measurePsf.py b/python/lsst/pipe/tasks/measurePsf.py
@@ -26,7 +26,7 @@
 import lsst.pex.config as pexConfig
 import lsst.pipe.base as pipeBase
 
-__all__ = ('MeasurePsfConfig', 'MeasurePsfTask')
+__all__ = ['MeasurePsfConfig', 'MeasurePsfTask']
 
 
 class MeasurePsfConfig(pexConfig.Config):

diff --git a/python/lsst/pipe/tasks/multiBand.py b/python/lsst/pipe/tasks/multiBand.py
@@ -32,7 +32,6 @@
 the mergeDet, meas, and ref dataset Footprints:
 - deepCoadd_peak_schema
 """
-import numpy
 
 from lsst.coadd.utils.coaddDataIdContainer import ExistingCoaddDataIdContainer
 from lsst.pipe.base import (CmdLineTask, Struct, ArgumentParser, ButlerInitializedTaskRunner,
@@ -59,11 +58,6 @@
 from .multiBandUtils import getInputSchema, getShortFilterName, readCatalog, _makeMakeIdFactory  # noqa: F401
 
 
-
-
-
-##############################################################################################################
-
 class DetectCoaddSourcesConfig(Config):
     """Configuration parameters for the DetectCoaddSourcesTask
     """

diff --git a/python/lsst/pipe/tasks/objectMasks.py b/python/lsst/pipe/tasks/objectMasks.py
@@ -4,7 +4,7 @@
 import lsst.afw.table as afwTable
 from lsst.log import Log
 
-__all__ = ('ObjectMaskCatalog',)
+__all__ = ['ObjectMaskCatalog',]
 
 
 class ObjectMaskCatalog:

diff --git a/python/lsst/pipe/tasks/repair.py b/python/lsst/pipe/tasks/repair.py
@@ -28,7 +28,7 @@
 from lsst.afw.display import getDisplay
 from lsst.pipe.tasks.interpImage import InterpImageTask
 
-__all__ = ('RepairConfig', 'RepairTask')
+__all__ = ['RepairConfig', 'RepairTask']
 
 
 class RepairConfig(pexConfig.Config):

diff --git a/python/lsst/pipe/tasks/scaleVariance.py b/python/lsst/pipe/tasks/scaleVariance.py
@@ -26,7 +26,7 @@
 from lsst.pipe.base import Task
 from lsst.meas.algorithms import SubtractBackgroundTask
 
-__all__ = ('ScaleVarianceConfig', 'ScaleVarianceTask')
+__all__ = ['ScaleVarianceConfig', 'ScaleVarianceTask']
 
 
 class ScaleVarianceConfig(Config):

diff --git a/python/lsst/pipe/tasks/scaleZeroPoint.py b/python/lsst/pipe/tasks/scaleZeroPoint.py
@@ -26,8 +26,8 @@
 import lsst.pipe.base as pipeBase
 from lsst.pipe.tasks.selectImages import BaseSelectImagesTask
 
-__all__ = ("ImageScaler", "SpatialImageScaler", "ScaleZeroPointTask", "ScaleZeroPointConfig",
-           "SpatialScaleZeroPointConfig", "SpatialScaleZeroPointTask")
+__all__ = ["ImageScaler", "SpatialImageScaler", "ScaleZeroPointTask", "ScaleZeroPointConfig",
+           "SpatialScaleZeroPointConfig", "SpatialScaleZeroPointTask"]
 
 
 class ImageScaler:

diff --git a/python/lsst/pipe/tasks/setConfigFromEups.py b/python/lsst/pipe/tasks/setConfigFromEups.py
@@ -33,10 +33,10 @@ def setAstrometryConfigFromEups(config, menu):
 
     .. code-block:: none
 
-        menu = { "ps1": {}, # No changes
+        menu = { "ps1*": {}, # No changes
                 "ps1-without-y": { "solver.filterMap": {"y": "z"} }, # No y-band in this specific version
-                "sdss": { "solver.filterMap": {"y": "z"} }, # No y-band, use z instead
-                "2mass": { "solver.filterMap": {"y": "J"} }, # No y-band, use J instead
+                "sdss*": { "solver.filterMap": {"y": "z"} }, # No y-band, use z instead
+                "2mass*": { "solver.filterMap": {"y": "J"} }, # No y-band, use J instead
             }
 
     """

diff --git a/python/lsst/pipe/tasks/setPrimaryFlags.py b/python/lsst/pipe/tasks/setPrimaryFlags.py
@@ -25,7 +25,7 @@
 from lsst.pipe.base import Task
 from lsst.afw.geom import Box2D
 
-__all__ = ('SetPrimaryFlagsConfig', 'SetPrimaryFlagsTask')
+__all__ = ['SetPrimaryFlagsConfig', 'SetPrimaryFlagsTask']
 
 
 class SetPrimaryFlagsConfig(Config):

diff --git a/python/lsst/pipe/tasks/snapCombine.py b/python/lsst/pipe/tasks/snapCombine.py
@@ -133,7 +133,8 @@ def validate(self):
 
 
 class SnapCombineTask(pipeBase.Task):
-    """
+    """Combine snaps.
+
     The lsst.pipe.base.cmdLineTask.CmdLineTask command line task interface supports a
     flag -d to import debug.py from your PYTHONPATH; see
     "http://lsst-web.ncsa.illinois.edu/~buildbot/doxygen/x_masterDoxyDoc/base_debug.html"

diff --git a/python/lsst/pipe/tasks/transformMeasurement.py b/python/lsst/pipe/tasks/transformMeasurement.py
@@ -188,8 +188,7 @@ class RunTransformTaskBase(pipeBase.CmdLineTask):
 
     @property
     def inputSchemaType(self):
-        """
-        The Butler dataset type for the schema of the input source catalog.
+        """The Butler dataset type for the schema of the input source catalog.
 
         By default, we append `_schema` to the input source type. Subclasses may customize
         if required.
@@ -198,8 +197,7 @@ def inputSchemaType(self):
 
     @property
     def outputDataset(self):
-        """
-        The Butler dataset type for the schema of the output catalog.
+        """The Butler dataset type for the schema of the output catalog.
 
         By default, we prepend `transformed` to the input source type. Subclasses may
         customize if required.
@@ -208,8 +206,7 @@ def outputDataset(self):
 
     @property
     def measurementConfig(self):
-        """
-        The configuration of the measurement operation used to generate the input catalog.
+        """The configuration of the measurement operation used to generate the input catalog.
 
         By default we look for `measurement` under the root configuration of the
         generating task. Subclasses may customize this (e.g. to `calibrate.measurement`)