Added docstring to _EmptyTargetTask

lsst · Mar 20, 2024 · 6a7085f · 6a7085f
1 parent 846ea3f
commit 6a7085f
Showing 1 changed file with 9 additions and 2 deletions.
diff --git a/python/lsst/pipe/tasks/calibrate.py b/python/lsst/pipe/tasks/calibrate.py
@@ -47,12 +47,19 @@
 
 
 class _EmptyTargetTask(pipeBase.PipelineTask):
+    """
+    This is a placeholder target for CreateSummaryMetrics and must be retargeted at runtime.
+    CreateSummaryMetrics should target an analysis tool task, but that would, at the time
+    of writing, result in a circular import.
+
+    As a result, this class should not be used for anything else.
+    """
     ConfigClass = pipeBase.PipelineTaskConfig
 
     def __init__(self, **kwargs) -> None:
         raise NotImplementedError(
-            "doCreateSummaryMetrics is set to True, in which case"
-            "CreateSummaryMetrics must be retargeted."
+            "doCreateSummaryMetrics is set to True, in which case "
+            "createSummaryMetrics must be retargeted."
         )