Skip to content

Commit bf5d6bd

Browse files
hyanwongmergify[bot]
authored andcommitted
Doc sequence_length
Fixes #703
1 parent e3fd5c1 commit bf5d6bd

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

tsinfer/formats.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1334,6 +1334,9 @@ def subset(self, individuals=None, sites=None, *, sequence_length=None, **kwargs
13341334
in the current dataset. Site IDs can be supplied in any order,
13351335
but the order will *not* be preserved in the returned data file,
13361336
so that sites are always in position sorted order in the output.
1337+
:param float sequence_length: The sequence length to use for the
1338+
returned object. If None, use the same sequence length as in the
1339+
original sample data file.
13371340
:param \\**kwargs: Further arguments passed to the :class:`SampleData`
13381341
constructor.
13391342
:return: A :class:`.SampleData` object.

0 commit comments

Comments
 (0)