Skip to content

Commit 67f2ef3

Browse files
hyanwongmergify[bot]
authored andcommitted
Clarify tree.mrca is MRCA does not exist
1 parent f7ba548 commit 67f2ef3

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

python/tskit/trees.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -997,7 +997,9 @@ def mrca(self, *args):
997997
Returns the most recent common ancestor of the specified nodes.
998998
999999
:param int `*args`: input node IDs, must be at least 2.
1000-
:return: The most recent common ancestor of input nodes.
1000+
:return: The node ID of the most recent common ancestor of the
1001+
input nodes, or :data:`tskit.NULL` if the nodes do not share
1002+
a common ancestor in the tree.
10011003
:rtype: int
10021004
"""
10031005
if len(args) < 2:

0 commit comments

Comments
 (0)