DOC: Fixed matched filter SNR documentation to match the returned values

d0109542 · Nico Bers · Colm Talbot · 84c73998 · d0109542 · d0109542
Commit d0109542 authored 1 year ago by Nico Bers Committed by Colm Talbot 1 year ago
--- a/AUTHORS.md
+++ b/AUTHORS.md
@@ -57,6 +57,7 @@ Michael Puerrer
 Michael Williams
 Monica Rizzo
 Moritz Huebner
+Nico Gerardo Bers
 Nicola De Lillo
 Nikhil Sarin
 Nirban Bose

--- a/bilby/gw/detector/interferometer.py
+++ b/bilby/gw/detector/interferometer.py
@@ -607,7 +607,7 @@ class Interferometer(object):

        Returns
        =======
-        float: The matched filter signal to noise ratio squared
+        complex: The matched filter signal to noise ratio

        """
        return gwutils.matched_filter_snr(