From 96777dc2bb9c1c025757c4e001c67576c7663b69 Mon Sep 17 00:00:00 2001 From: Yan Wong Date: Thu, 5 Dec 2024 14:42:50 +0000 Subject: [PATCH] Clarify mutation order in Site() object This is useful to know without having to dive into the order requirements docs --- python/tskit/trees.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/python/tskit/trees.py b/python/tskit/trees.py index 19ee9551a1..ccdc06240b 100644 --- a/python/tskit/trees.py +++ b/python/tskit/trees.py @@ -358,7 +358,8 @@ class Site(util.Dataclass): mutations: np.ndarray """ The list of mutations at this site. Mutations within a site are returned in the - order they are specified in the underlying :class:`MutationTable`. + order they are specified in the underlying :class:`MutationTable`. In particular, + this means that older mutations will be listed before younger ones at this site. """ metadata: bytes | dict | None """