diff --git a/CHANGELOG.md b/CHANGELOG.md index 16c762f38..20b2e823f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,9 @@ The original MRs are only visible on the [LIGO GitLab repository](https://git.li ## [Unreleased] +### Fixes +* Corrected incorrect docstrings for `matched_filter_snr` and `optimal_snr_squared` in `bilby/gw/utils.py` (closes #731) + ## [2.7.1] ### Fixes diff --git a/bilby/gw/utils.py b/bilby/gw/utils.py index f1f4c0291..420e1fc04 100644 --- a/bilby/gw/utils.py +++ b/bilby/gw/utils.py @@ -155,7 +155,7 @@ def matched_filter_snr(signal, frequency_domain_strain, power_spectral_density, Returns ======= - float: The matched filter signal to noise ratio squared + complex: The complex matched filter signal to noise ratio """ rho_mf = noise_weighted_inner_product( @@ -184,7 +184,7 @@ def optimal_snr_squared(signal, power_spectral_density, duration): Returns ======= - float: The matched filter signal to noise ratio squared + float: The square of the optimal matched filter signal to noise ratio """ return noise_weighted_inner_product(signal, signal, power_spectral_density, duration)