Skip to content

Commit 6091bd3

Browse files
committed
Clarify the get_cumulative_mass docs
1 parent 0e451c6 commit 6091bd3

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

python/tskit/intervals.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -247,9 +247,10 @@ def get_cumulative_mass(self, x=None):
247247
given point for a list of positions along the map. This is equal to
248248
the integral of the rate from 0 to the point.
249249
250-
.. note:: If the RateMap is a "genetic map" (that is, it measures the
251-
rate of recombination along the genome), this function will return
252-
the "genetic distance" along the chromosome, e.g. in Morgans
250+
.. note:: If the RateMap is a "genetic map" measuring the
251+
rate of recombination along a chromosome, this function will return
252+
the "genetic distance" (i.e. the map distance) for the provided
253+
physical positions e.g. in Morgans.
253254
254255
:param numpy.ndarray x: The positions for which to return values. If None,
255256
get the cumulative mass at each :attr:`~.RateMap.position` used
@@ -527,7 +528,8 @@ def read_hapmap(
527528
physical position in the file is marked as unknown. Otherwise, act
528529
as if an additional row, specifying physical position 0 and genetic
529530
position 0, exists at the start of the file.
530-
:return: A RateMap object.
531+
:return: A RateMap object, whose :meth:`get_cumulative_mass` method can
532+
be used to translate physical positions into positions in the genetic map.
531533
:rtype: RateMap
532534
"""
533535
# fmt: on

0 commit comments

Comments
 (0)