Skip to content

Commit 7245feb

Browse files
petrelharphyanwong
authored andcommitted
Apply suggestions from code review
1 parent 93f819d commit 7245feb

2 files changed

Lines changed: 4 additions & 4 deletions

File tree

c/tskit/tables.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -869,8 +869,8 @@ this option adds all edges.
869869
*/
870870
#define TSK_UNION_ALL_EDGES (1 << 2)
871871
/**
872-
By default, union only adds only mutations on newly added edges;
873-
this option adds all mutations.
872+
By default, union only adds only mutations on newly added edges, and
873+
sites for those mutations; this option adds all mutations and all sites.
874874
*/
875875
#define TSK_UNION_ALL_MUTATIONS (1 << 3)
876876
/** @} */

python/tskit/tables.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4355,9 +4355,9 @@ def union(
43554355
``tskit.NULL`` if the node is not present in ``self`` (in which case it
43564356
will be added to self).
43574357
:param bool all_edges: If True, then all edges in ``other`` are added
4358-
to ``self``. Must have ``check_shared_equality=False``.
4358+
to ``self``.
43594359
:param bool all_mutations: If True, then all mutations in ``other`` are added
4360-
to ``self``. Must have ``check_shared_equality=False``.
4360+
to ``self``.
43614361
:param bool check_shared_equality: If True, the shared portions of the
43624362
table collections will be checked for equality.
43634363
:param bool add_populations: If True, nodes new to ``self`` will be

0 commit comments

Comments
 (0)