From 2e931137beb9cfda441e0e454b35b277a865701f Mon Sep 17 00:00:00 2001
From: Samuel Mondal <samuel.mondal@unibas.ch>
Date: Sun, 27 Nov 2022 00:00:28 +0100
Subject: [PATCH] updated docstrings
---
sequence_extractor/exon_concatenation.py | 4 ++--
sequence_extractor/polyA.py | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/sequence_extractor/exon_concatenation.py b/sequence_extractor/exon_concatenation.py
index d95ef0a..4a4b1c0 100644
--- a/sequence_extractor/exon_concatenation.py
+++ b/sequence_extractor/exon_concatenation.py
@@ -1,13 +1,13 @@
def exon_concatenation(
post_bedtools_fasta: str
) -> list:
- """Concatenate all sequences starting with identical transcripit ID and outputs it as a list with sequence header (Transcript ID) and concatenated sequences.
+ """Concatenate all sequences starting with identical transcripit ID and outputs it as a list with sequence header (Transcript ID) and concatenated sequences as tuples.
Args:
post_bedtools_fasta: The name of the fasta file obtained after bedtools has been run
Returns:
- A list with transcript ID in even indices and corresponding concatenated exons in odd indices.
+ A list containing transcript ID and concatenated exons in tuples.
"""
with open(post_bedtools_fasta,'r') as fa:
annotation = []
diff --git a/sequence_extractor/polyA.py b/sequence_extractor/polyA.py
index 8c1715a..cafa91b 100644
--- a/sequence_extractor/polyA.py
+++ b/sequence_extractor/polyA.py
@@ -18,10 +18,10 @@ def polyA_generator(
def polyA_addition_to_fasta_list(
fasta_list: list,
) -> list:
- """Takes in a list of alternate annotations and exons and outputs a list where polyA tail has been added to all the exon 3' ends.
+ """Takes in a list of tuples with annotations and exons and outputs a list where polyA tail has been added to all the exon 3' ends.
Args:
- fasta_list: List contaning annotations and exons, with every element being an equivalent to a line in the fasta file
+ fasta_list: List contaning tuples of annotations and exons
Returns:
A list like the initial list, this time with polyA tail added onto it.
--
GitLab