From 960cb6de10c64f5c7dd80f0957e7bc8acea2d566 Mon Sep 17 00:00:00 2001
From: free hacker <freeh4cker@gmail.com>
Date: Thu, 18 Feb 2016 00:33:12 +0100
Subject: [PATCH] add docstrings

---
 source/_static/code/fasta_object.py | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/source/_static/code/fasta_object.py b/source/_static/code/fasta_object.py
index a1f9b7b..09c7b87 100644
--- a/source/_static/code/fasta_object.py
+++ b/source/_static/code/fasta_object.py
@@ -17,6 +17,11 @@ class FastaParser(object):
         self._current_sequence = ''
 
     def _parse_header(self, line):
+        """
+        parse the header line and  _current_id|comment|sequence attributes
+        :param line: the line of header in fasta format
+        :type line: string
+        """
         header = line.split()
         self._current_id = header[0]
         self._current_comment = ' '.join(header[1:])
@@ -26,6 +31,13 @@ class FastaParser(object):
         return self
 
     def next(self):
+        """
+        :return: at each call return a new :class:`Sequence` object
+        :raise: StopIteration
+        """
+        """
+        :return:
+        """
         for line in self._file:
             if line.startswith('>'):
                 # a new sequence begin
-- 
GitLab