Fix docstrings on linearizers.

lsst · Oct 22, 2020 · 943c655 · 943c655
1 parent 5b13108
commit 943c655
Showing 1 changed file with 24 additions and 12 deletions.
diff --git a/python/lsst/ip/isr/linearize.py b/python/lsst/ip/isr/linearize.py
@@ -557,8 +557,10 @@ def __call__(self, image, **kwargs):
 
         Returns
         -------
-        output : `bool`
-            If true, a correction was applied successfully.
+        output : `tuple` [`bool`, `int`]
+            If true, a correction was applied successfully.  The
+            integer indicates the number of pixels that were
+            uncorrectable by being out of range.
 
         Raises
         ------
@@ -625,8 +627,10 @@ def __call__(self, image, **kwargs):
 
         Returns
         -------
-        output : `bool`
-            If true, a correction was applied successfully.
+        output : `tuple` [`bool`, `int`]
+            If true, a correction was applied successfully.  The
+            integer indicates the number of pixels that were
+            uncorrectable by being out of range.
         """
         if not np.any(np.isfinite(kwargs['coeffs'])):
             return False, 0
@@ -667,8 +671,10 @@ def __call__(self, image, **kwargs):
 
         Returns
         -------
-        output : `bool`
-            If true, a correction was applied successfully.
+        output : `tuple` [`bool`, `int`]
+            If true, a correction was applied successfully.  The
+            integer indicates the number of pixels that were
+            uncorrectable by being out of range.
         """
 
         sqCoeff = kwargs['coeffs'][0]
@@ -711,8 +717,10 @@ def __call__(self, image, **kwargs):
 
         Returns
         -------
-        output : `bool`
-            If true, a correction was applied successfully.
+        output : `tuple` [`bool`, `int`]
+            If true, a correction was applied successfully.  The
+            integer indicates the number of pixels that were
+            uncorrectable by being out of range.
         """
         splineCoeff = kwargs['coeffs']
         centers, values = np.split(splineCoeff, 2)
@@ -747,8 +755,10 @@ def __call__(self, image, **kwargs):
 
         Returns
         -------
-        output : `bool`
-            If true, a correction was applied successfully.
+        output : `tuple` [`bool`, `int`]
+            If true, a correction was applied successfully.  The
+            integer indicates the number of pixels that were
+            uncorrectable by being out of range.
         """
         return True, 0
 
@@ -774,7 +784,9 @@ def __call__(self, image, **kwargs):
 
         Returns
         -------
-        output : `bool`
-            If true, a correction was applied successfully.
+        output : `tuple` [`bool`, `int`]
+            If true, a correction was applied successfully.  The
+            integer indicates the number of pixels that were
+            uncorrectable by being out of range.
         """
         return True, 0