From 70fb4c4b1ff3b4352d24fa5a0ae4a9e4d185647c Mon Sep 17 00:00:00 2001 From: Marco Biasini <marco.biasini@unibas.ch> Date: Wed, 23 Mar 2011 14:22:52 +0100 Subject: [PATCH] fix documentation for SaveSequence and friends --- modules/io/doc/io.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/modules/io/doc/io.rst b/modules/io/doc/io.rst index 141a1434c..4746f452c 100644 --- a/modules/io/doc/io.rst +++ b/modules/io/doc/io.rst @@ -168,7 +168,7 @@ Loading sequence or alignment files Saving Sequence Data ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -.. function:: SaveSequence(filename, format='auto') +.. function:: SaveSequence(sequence, filename, format='auto') Saving sequence data is performed by calling :func:`SaveSequence`. For files with non-standard extensions, the format can be set explicitly @@ -193,13 +193,13 @@ Saving Sequence Data :exc:`~ost.io.IOException` if the import fails due to an erroneous or inexistent file -.. function:: SaveSequenceList(filename, format='auto') +.. function:: SaveSequenceList(seq_list, filename, format='auto') For a desription of how to use :func:`SaveSequenceList` please refer to :func:`SaveSequence`. For a list of file formats supported by :func:`SaveSequenceList` see :doc:`formats`. -.. function:: SaveAlignment(filename, format='auto') +.. function:: SaveAlignment(aln, filename, format='auto') For a desription of how to use :func:`SaveAlignment` please refer to :func:`SaveSequence`. -- GitLab