Edited documentation

matteobolner · Sep 15, 2024 · 1677c4d · 1677c4d
1 parent f544e67
commit 1677c4d
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 19 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
-name = "ncbi_genome"
-version = "0.1.0"
+name = "genomers"
+version = "0.1.1"
 edition = "2021"
 
 [dependencies]

diff --git a/src/accession.rs b/src/accession.rs
@@ -95,6 +95,8 @@ impl NCBIGenome {
     }
 }
 
+///TESTS
+
 #[cfg(test)]
 mod tests {
     use crate::accession::NCBIGenome;

diff --git a/src/main.rs b/src/main.rs
@@ -1,10 +1,11 @@
 use clap::Parser;
-use download::download;
 
 pub mod accession;
 use crate::accession::NCBIGenome;
 pub mod download;
+use download::download;
 
+/// Simple program to download genome information and sequence from NCBI
 #[derive(Parser, Debug)]
 #[command(version, about, long_about = None)]
 struct Args {
@@ -14,16 +15,14 @@ struct Args {
     /// Assembly name
     #[arg(required = true, short, long)]
     name: String,
-    /// Download assembly report
+    /// Download assembly report in txt format
     #[arg(group = "download", short, long)]
     report: bool,
-    /// Download assembly report
+    /// Download assembly sequence in fna.gz format
     #[arg(group = "download", short, long)]
     genome: bool,
 }
 
-//-a GCF_000005845.2 -n ASM584v2
-
 //TODO if no assembly name specified download the most recent (needs ftp?)
 
 fn main() {