Skip to content

Commit d8a7958

Browse files
authored
Update DDsmu docstring [ci skip]
1 parent 7ad3c28 commit d8a7958

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

Corrfunc/theory/DDsmu.py

+4-3
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,10 @@ def DDsmu(autocorr, nthreads, binfile, mu_max, nmu_bins,
2828
by less than the ``s`` bins (specified in ``binfile``) in 3-D, and
2929
less than ``s*mu_max`` in the Z-dimension are counted.
3030
31-
If ``weights`` are provided, the resulting pair counts are weighted. The
32-
weighting scheme depends on ``weight_type``.
33-
31+
If ``weights`` are provided, the mean pair weight is stored in the
32+
``"weightavg"`` field of the results array. The raw pair counts in the
33+
``"npairs"`` field are not weighted. The weighting scheme depends on
34+
``weight_type``.
3435
3536
.. note:: This module only returns pair counts and not the actual
3637
correlation function :math:`\\xi(s, \mu)`. See the

0 commit comments

Comments
 (0)