Skip to content

Commit 7ad3c28

Browse files
authored
Fix DDrppi weights docstring [ci skip]
1 parent c29bcf4 commit 7ad3c28

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

Corrfunc/theory/DDrppi.py

+4-3
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,10 @@ def DDrppi(autocorr, nthreads, pimax, binfile, X1, Y1, Z1, weights1=None,
2727
X-Y plane, and less than ``pimax`` in the Z-dimension are
2828
counted.
2929
30-
If ``weights`` are provided, the resulting pair counts are weighted. The
31-
weighting scheme depends on ``weight_type``.
32-
30+
If ``weights`` are provided, the mean pair weight is stored in the
31+
``"weightavg"`` field of the results array. The raw pair counts in the
32+
``"npairs"`` field are not weighted. The weighting scheme depends on
33+
``weight_type``.
3334
3435
.. note:: that this module only returns pair counts and not the actual
3536
correlation function :math:`\\xi(r_p, \pi)` or :math:`wp(r_p)`. See the

0 commit comments

Comments
 (0)