A metric $#%$-ton of changes. Added doc-strings to EVERYTHING. Phew. Fixed a massive bug that

increases performance in by up to a factor of 60.  A bunch of new behaviors for the class.

2 files changed, 10 insertions, 1 deletions

diff --git a/layouts/LineLayout.py b/layouts/LineLayout.py
index 34f5e36..1d40105 100644
--- a/layouts/LineLayout.py
+++ b/layouts/LineLayout.py
@@ -1,5 +1,5 @@
 from operationscore.PixelAssembler import *
-#Simple layout class that simply makes a line of LEDs
 class LineLayout(PixelAssembler):
+    """LineLayout is a layout class that makes a line of LEDs"""
     def layoutFunc(self, lastLocation):
         return (lastLocation[0]+self.argDict['spacing'], lastLocation[1])
diff --git a/layouts/ZigzagLayout.py b/layouts/ZigzagLayout.py
index 221571c..3fc2ea1 100644
--- a/layouts/ZigzagLayout.py
+++ b/layouts/ZigzagLayout.py
@@ -10,6 +10,15 @@ import pdb
 # |
 # X-X-X-X etc.
 class ZigzagLayout(PixelAssembler):
+    """ZigZagLayout is a slightly more complex layout class that makes a zig-Zag Led Pattern
+    Inheriting classes must specify zigLength, the length in lights of a of a zig
+    and zig Axis, the direction of the long X axis (X or Y).
+    EG: zig length = 4, zig Axis = X would give:
+     X-X-X-X
+           |
+     X-X-X-X
+     |
+     X-X-X-X etc.
     def initLayout(self):
         if not 'zigLength' in self.argDict:
             raise Exception('zigLength must be defined in argDict')