Skip to content

Commit a9e4f88

Browse files
authored
Clarify mutation order in Site() object (#3067)
This is useful to know without having to dive into the order requirements docs
1 parent a2a3401 commit a9e4f88

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

python/tskit/trees.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,11 @@ class Site(util.Dataclass):
370370
mutations: np.ndarray
371371
"""
372372
The list of mutations at this site. Mutations within a site are returned in the
373-
order they are specified in the underlying :class:`MutationTable`.
373+
374+
order they are specified in the underlying :class:`MutationTable`. For canonical
375+
(i.e., valid) tables, this means ancestral mutations precede their descendants, so
376+
older mutations (as defined by the canonical mutation ordering; see
377+
:ref:`sec_mutation_requirements`) appear before younger ones.
374378
"""
375379
metadata: bytes | dict | None
376380
"""

0 commit comments

Comments
 (0)