Fix incorrect docstrings in ReferenceObjectLoader.

lsst · Apr 20, 2022 · 586906b · 586906b
1 parent e3e8d75
commit 586906b
Showing 1 changed file with 27 additions and 9 deletions.
diff --git a/python/lsst/meas/algorithms/loadReferenceObjects.py b/python/lsst/meas/algorithms/loadReferenceObjects.py
@@ -805,9 +805,15 @@ def loadPixelBox(self, bbox, wcs, filterName, epoch=None,
 
         Returns
         -------
-        referenceCatalog : `lsst.afw.table.SimpleCatalog`
-            Catalog containing reference objects inside the specified bounding
-            box (padded by self.config.pixelMargin).
+        output : `lsst.pipe.base.Struct`
+            Results struct with attributes:
+
+            ``refCat``
+                Catalog containing reference objects inside the specified
+                bounding box (padded by self.config.pixelMargin).
+            ``fluxField``
+                Name of the field containing the flux associated with
+                ``filterName``.
 
         Raises
         ------
@@ -886,9 +892,15 @@ class which intersect or are contained within the specified region. The
 
         Returns
         -------
-        referenceCatalog : `lsst.afw.table.SourceCatalog`
-            Catalog containing reference objects which intersect the input region,
-            filtered by the specified filter function.
+        output : `lsst.pipe.base.Struct`
+            Results struct with attributes:
+
+            ``refCat``
+                Catalog containing reference objects which intersect the
+                input region, filtered by the specified filter function.
+            ``fluxField``
+                Name of the field containing the flux associated with
+                ``filterName``.
 
         Raises
         ------
@@ -991,9 +1003,15 @@ def loadSkyCircle(self, ctrCoord, radius, filterName, epoch=None):
 
         Returns
         -------
-        referenceCatalog : `lsst.afw.table.SourceCatalog`
-            Catalog containing reference objects inside the specified search
-            circle.
+        output : `lsst.pipe.base.Struct`
+            Results struct with attributes:
+
+            ``refCat``
+                Catalog containing reference objects inside the specified
+                search circle.
+            ``fluxField``
+                Name of the field containing the flux associated with
+                ``filterName``.
         """
         centerVector = ctrCoord.getVector()
         sphRadius = sphgeom.Angle(radius.asRadians())