From f732f95e5c2ac64ce4e6d7075c1e3fc52187a9b4 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bertrand=20N=C3=A9ron?= <bneron@pasteur.fr>
Date: Mon, 7 Jun 2021 08:24:53 +0200
Subject: [PATCH] fix docstrings in restriction.py
---
source/_static/code/restriction.py | 13 +++++++------
1 file changed, 7 insertions(+), 6 deletions(-)
diff --git a/source/_static/code/restriction.py b/source/_static/code/restriction.py
index 7227b69..91bc798 100644
--- a/source/_static/code/restriction.py
+++ b/source/_static/code/restriction.py
@@ -1,8 +1,9 @@
from operator import itemgetter
# we decide to implement enzyme as tuple with the following structure
-# ("name", "comment", "sequence", "cut", "end")
-# 0 1 2 3 4
+# (name, comment, sequence, cut, end)
+# 0 1 2 3 4
+
def one_enz_one_binding_site(dna, enzyme):
"""
@@ -19,7 +20,7 @@ def one_enz_all_binding_sites(dna, enzyme):
:param dna: the dna sequence to search enzyme binding sites
:type dna: str
:param enzyme: the enzyme to looking for
- :type enzyme: a namedtuple RestrictEnzyme
+ :type enzyme: a tuple (str name, str comment, str sequence, int cut, str end)
:return: all positions of enzyme binding sites in dna
:rtype: list of int
"""
@@ -36,7 +37,7 @@ def one_enz_all_binding_sites2(dna, enzyme):
:param dna: the dna sequence to search enzyme binding sites
:type dna: str
:param enzyme: the enzyme to looking for
- :type enzyme: a namedtuple RestrictEnzyme
+ :type enzyme: a tuple (str name, str comment, str sequence, int cut, str end)
:return: all positions of enzyme binding sites in dna
:rtype: list of int
"""
@@ -60,8 +61,8 @@ def binding_sites(dna, enzymes):
:param dna: the dna sequence to search enzyme binding sites
:type dna: str
- :param enzyme: the enzyme to looking for
- :type enzyme: a namedtuple RestrictEnzyme
+ :param enzymes: the enzymes to looking for
+ :type enzymes: a sequence of enzyme tuple
:return: all positions of each enzyme binding sites in dna
:rtype: list of int
"""
--
GitLab