DOC add comment on binsize definition

rmjarvis · Dec 4, 2023 · d6bb668 · d6bb668
1 parent 3b6b5b3
commit d6bb668
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/docs/binning.rst b/docs/binning.rst
@@ -170,7 +170,10 @@ values.
 
 The approximation TreeCorr makes is to allow some *additional* imprecision that is a
 fraction of this level.  Namely ``bin_slop``.  Specifically, ``bin_slop`` specifies the
-maximum possible error any pair can have, given as a fraction of the bin size.
+maximum possible error any pair can have, given as a fraction of the bin size. By bin size,
+we mean the size in logarithmic units for log binning (i.e., ``log(H) - log(L)``
+and linear units for linear binning (i.e., ``H-L``) where ``H`` and ``L`` are the upper
+anf lower bounds of the bin.
 
 You can think of it as turning all of your rectangular bins into overlapping trapezoids,
 where ``bin_slop`` defines the ratio of the angled portion to the flat mean width.