Update doc, add asserts

lbl-anp · Jul 21, 2021 · 02a1eec · 02a1eec
1 parent 34bdf4a
commit 02a1eec
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/becquerel/core/utils.py b/becquerel/core/utils.py
@@ -131,11 +131,13 @@ def sqrt_bins(bin_edge_min, bin_edge_max, nbins):
     Square root binning
 
     Args:
-      bin_edge_min (float): Minimum bin edge (must be greater than 0)
+      bin_edge_min (float): Minimum bin edge (must be >= 0)
       bin_edge_max (float): Maximum bin edge (must be greater than bin_min)
       nbins (int): Number of bins
 
     Returns:
       np.array of bin edges (length = nbins + 1)
     """
+    assert bin_edge_min >= 0
+    assert bin_edge_max > bin_edge_min
     return np.linspace(np.sqrt(bin_edge_min), np.sqrt(bin_edge_max), nbins + 1) ** 2