From 80f0ac1483882d00bf6f574a28903028e5f05c1c Mon Sep 17 00:00:00 2001
From: Laurent Modolo <laurent.modolo@ens-lyon.fr>
Date: Mon, 18 Dec 2023 10:20:12 +0100
Subject: [PATCH] read.rs: update doc

---
 src/read.rs | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/src/read.rs b/src/read.rs
index 869841a..e6a4f92 100644
--- a/src/read.rs
+++ b/src/read.rs
@@ -217,12 +217,12 @@ impl Fragments {
         }
     }
 
-    /// create a new pair of Read starting a given chromosome id and position
+    /// create a &str corresponding to a read starting at a given position
     /// # Arguments
     /// - chr_pos: u32 the chromosome position
     /// - first: bool is the sequence for the R1 ?
     /// # Return
-    /// (Read, Read)
+    /// &str
     fn get_seq(&mut self, chr_pos: u32, first: bool) -> &str {
         let mut start = chr_pos;
         let mut end = self.chr_seq.len() as u32;
-- 
GitLab