Skip to content

Commit

Permalink
Clarify mutation order in Site() object
Browse files Browse the repository at this point in the history
This is useful to know without having to dive into the order requirements docs
  • Loading branch information
hyanwong committed Dec 5, 2024
1 parent d1d5bb7 commit 96777dc
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion python/tskit/trees.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
"""
Expand Down

0 comments on commit 96777dc

Please sign in to comment.