Skip to content

Commit 9fc519e

Browse files
committed
Fix docs SampleData refs
1 parent 8889807 commit 9fc519e

File tree

1 file changed

+2
-3
lines changed

1 file changed

+2
-3
lines changed

tsdate/util.py

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -325,12 +325,11 @@ def add_sampledata_times(samples, sites_time):
325325
Ensures that each site's time is at least as old as the oldest historic sample
326326
carrying a derived allele at that site.
327327
328-
:param tsinfer.formats.SampleData samples: A tsinfer SampleData object to
328+
:param samples: A tsinfer SampleData object to
329329
add site times to. Any historic individuals in this SampleData file are used to
330330
constrain site times.
331331
332-
:return: A tsinfer.SampleData file
333-
:rtype: tsinfer.SampleData
332+
:return: A copy of the input sample data with site times added
334333
"""
335334
if samples.num_sites != len(sites_time):
336335
raise ValueError(

0 commit comments

Comments
 (0)