Skip to content

Commit 0995045

Browse files
benjefferymergify[bot]
authored andcommitted
Add note to CLI
1 parent 97ffde3 commit 0995045

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/cli.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44
Command line interface
55
======================
66

7+
.. warning::
8+
9+
The command line interface only supports the deprecated SampleData format
10+
used in tsinfer<0.4.0.
11+
712
The command line interface in ``tsinfer`` is intended to provide a convenient
813
interface to the high-level :ref:`API functionality <sec_api>`. There are two
914
equivalent ways to invoke this program:
@@ -25,7 +30,7 @@ form is useful when multiple versions of Python are installed or if the
2530
The :command:`tsinfer` program has five subcommands: :command:`list` prints a
2631
summary of the data held in one of tsinfer's :ref:`file formats <sec_file_formats>`;
2732
:command:`infer` runs the complete :ref:`inference process <sec_inference>` for a given
28-
input VCF Zarr dataset; and
33+
input SampleData file; and
2934
:command:`generate-ancestors`, :command:`match-ancestors` and
3035
:command:`match-samples` run the three parts of this inference
3136
process as separate steps. Running the inference as separate steps like this

0 commit comments

Comments
 (0)