stoichiograph

commit 59fc593f8a06899b96ca8f6becccd25b0d881f55
parent a6b2035363d88b32e9e09ee563b1e3a3348f2060
Author: Amin Mesbah <mesbah.amin@gmail.com>
Date:   Sun, 31 Jan 2016 16:11:00 -0800

add docstrings

Diffstat:
M
speller.py
 | 
6
++++++

1 file changed, 6 insertions(+), 0 deletions(-)
diff --git a/speller.py b/speller.py
@@ -16,6 +16,7 @@ def main():
 
 
 def tokenize_sequence(sequence):
+    """Return a list each of all single and double character tokens."""
     t = namedtuple('Tokens', (['single', 'pair']))
 
     single = [sequence[i:i+1] for i in range(0, len(sequence))]
@@ -26,6 +27,9 @@ def tokenize_sequence(sequence):
 
 
 def find_matches(sequence, symbols):
+    """Return a list of all element symbols matching
+    an item in the given sequence.
+    """
     matches = []
     indices = []
     lower_symbols = [i.lower() for i in symbols]
@@ -34,10 +38,12 @@ def find_matches(sequence, symbols):
     for i in lower_sequence:
         matches += (x for x in lower_symbols if x == i)
         indices += (lower_symbols.index(x) for x in lower_symbols if x == i)
+
     return matches
 
 
 def get_csv_data(file_name, column):
+    """Return in a list all data from a given column of a .csv file"""
     data = []
 
     with open(file_name) as infile: