File tree Expand file tree Collapse file tree 1 file changed +6
-3
lines changed Expand file tree Collapse file tree 1 file changed +6
-3
lines changed Original file line number Diff line number Diff line change @@ -2181,9 +2181,12 @@ def _sample_generator(self, u):
2181
2181
def samples (self , u = None ):
2182
2182
"""
2183
2183
Returns an iterator over the numerical IDs of all the sample nodes in
2184
- this tree that are underneath node ``u``. If ``u`` is a sample, it is
2185
- included in the returned iterator. If u is not specified, return all
2186
- sample node IDs in the tree.
2184
+ this tree that are underneath the node with ID ``u``. If ``u`` is a sample,
2185
+ it is included in the returned iterator. If ``u`` is not a sample, it is
2186
+ possible for the returned iterator to be empty, for example if ``u`` is an
2187
+ :meth:`isolated<Tree.is_isolated>` node that is not part of the the current
2188
+ topology. If u is not specified, return all sample node IDs in the tree
2189
+ (equivalent to all the sample node IDs in the tree sequence).
2187
2190
2188
2191
If the :meth:`TreeSequence.trees` method is called with
2189
2192
``sample_lists=True``, this method uses an efficient algorithm to find
You can’t perform that action at this time.
0 commit comments