Comments at principal scripts

Author: Ismael Taboada

huffman.py

@@ -2,7 +2,6 @@
 # -*- coding: utf-8 -*-
 
 """Python implementation of Huffman Coding
-
 """
 __author__ =  'Ismael Taboada'
 __version__=  '1.0'
@@ -12,7 +11,7 @@
 
 
 class HuffmanCoding(object):
-    """docstring for HuffmanCoding"""
+    """HuffmanCoding implementation"""
 
     def __init__(self):
         super(HuffmanCoding, self).__init__()
@@ -32,7 +31,7 @@ def encode(self,symb2freq):
         self.tree = heap[0]
 
     def tree_to_graph(self,tree=None,n="",comment="Huffman Coding",formatin="png",graph=None):
-        """Based on the Huffman Coding it create a graph with graphviz library
+        """Based on the Huffman Coding it creates a graph with graphviz library
 
         :param comment: graph comment
         :param formatin: graph format

main.py

@@ -3,8 +3,7 @@
 
 """Python implementation of Huffman Coding
 
-This program implements the huffman coding used for encoding a group of symbols
-by a preface
+This script test the implementation software of Huffman Coding at \'main.py\'.
 """
 __author__ =  'Ismael Taboada'
 __version__=  '1.0'
@@ -22,28 +21,41 @@
 LOG_FILE = 'log.csv'
 TEST = "this is an example for huffman encoding"
 
+"""Test for Graphviz software
+"""
 try:
     dot = Digraph()
 except Exception as e:
     raise
     print "Error: Graphviz software not found.\nPlease install Graphviz software on your computer.(http://www.graphviz.org/Download.php)"
     exit(1)
 
-
+"""User input
+"""
 txtin = raw_input("Write some symbols(blank for sample case):")
 txtin = TEST if txtin=="" else txtin
 txtout = txtin
+
+"""Extract frecuency of each symbol of set
+"""
 symb2freq = defaultdict(int)
 for ch in txtin:
     symb2freq[ch] += 1
 
+"""Implementation of Huffman Algorithm
+"""
 start = time.time()
 huff = HuffmanCoding()
 huff.encode(symb2freq)
 end = time.time()
 time_lapse = end - start
+
+"""Conversion from Huffman Coding Tree to Coding table
+"""
 coding_table = huff.tree_to_table()
 
+"""Outputs
+"""
 print "Codes table"
 print "Symbol\tFrec\tCode"
 for coding in coding_table:
@@ -55,10 +67,15 @@
 print "\nText input:",txtin
 print "Text output:",txtout
 
+"""Huffman tree Graphviz visualization
+"""
 dot = huff.tree_to_graph()
 print "\nDiagram saved at: ",DIA_FILE+'.png'
 dot.render(DIA_FILE, view=DEBUG)
 
+
+"""Log of input's size and execution time
+"""
 log_exits = os.path.isfile(LOG_FILE)
 
 with open(LOG_FILE, 'ab') as csvfile: