From fa03193941d25973e5983aad57401e2ffad7cd45 Mon Sep 17 00:00:00 2001
From: Amandine PERRIN <amandine.perrin@pasteur.fr>
Date: Tue, 5 Nov 2019 10:05:12 +0100
Subject: [PATCH] Complete docstring for genome_seq_functions

---
 PanACoTA/annotate_module/genome_seq_functions.py | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/PanACoTA/annotate_module/genome_seq_functions.py b/PanACoTA/annotate_module/genome_seq_functions.py
index c5b2105c..26761fb1 100755
--- a/PanACoTA/annotate_module/genome_seq_functions.py
+++ b/PanACoTA/annotate_module/genome_seq_functions.py
@@ -117,7 +117,7 @@ def analyse_genome(genome, dbpath, tmp_path, cut, pat, genomes, soft):
         pattern on which contigs must be cut. ex: "NNNNN"
     genomes : dict
         {genome_file: [genome_name]} as input, and will be changed to\
-         -> {genome_file: [genome_name, path, path_annotate, gsize, nbcont, L90]}
+        {genome_file: [genome_name, path, path_annotate, gsize, nbcont, L90]}
     soft : str
         soft used (prokka, prodigal, or None if called by prepare module)
 
@@ -125,6 +125,8 @@ def analyse_genome(genome, dbpath, tmp_path, cut, pat, genomes, soft):
     -------
     bool
         True if genome analysis went well, False otherwise
+        Modifies 'genomes' for the analysed genome: -> {genome_file: [genome_name, path,
+        path_annotate, gsize, nbcont, L90]}
     """
     gpath, grespath = get_output_dir(soft, dbpath, tmp_path, genome, cut, pat)
     # Open original sequence file
-- 
GitLab