Add comments for VectorAssembler

[soc.git] / TLB / src / VectorAssembler.py

diff --git a/TLB/src/VectorAssembler.py b/TLB/src/VectorAssembler.py
index 517dc51edefcfabfab09f1212517aeaba6998668..a0b0e85978e7ccda312ab31a2b282d65dbb88d10 100644 (file)
--- a/TLB/src/VectorAssembler.py
+++ b/TLB/src/VectorAssembler.py
@@ -2,7 +2,19 @@ from nmigen import Array, Module, Signal
 from nmigen.cli import main 
 
 class VectorAssembler():
+    """ Vector Assembler
+    
+        The purpose of this module is to take a generic number of inputs
+        and cleanly combine them into one vector. While this is very much 
+        possible through raw code it may result in a very unfortunate sight
+        in a yosys graph. Thus this class was born! No more will ugly loops 
+        exist in my graphs! Get outta here ya goddam Lochness Monster. 
+    """
     def __init__(self, width):
+        """ Arguments:
+            * width: (bit count) The desiered size of the output vector
+        
+        """
         # Internal
         self.width = width