add Raises to XYXYMatch.__call__

spacetelescope · May 17, 2024 · 3589758 · 3589758
1 parent dcaed93
commit 3589758
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/tweakwcs/matchutils.py b/tweakwcs/matchutils.py
@@ -187,6 +187,11 @@ def __call__(self, refcat, imcat, tp_pscale=1.0, tp_units=None, **kwargs):
             A tuple of two 1D `numpy.ndarray` containing indices of matched
             sources in the ``refcat`` and ``imcat`` catalogs accordingly.
 
+        Raises
+        ------
+        MatchSourceConfusionError
+            Multiple sources matched a single reference source. Try different
+            values for ``tolerance`` and ``separation`` to fix this error.
         """
         # Check catalogs:
         if not isinstance(refcat, astropy.table.Table):