-

Ram Rachum · Ram Rachum · commit 0b5b77ab2bc5 · 2011-02-16T23:02:25.000-05:00
diff --git a/misc/testing/__init__.py b/misc/testing/__init__.py
@@ -0,0 +1,5 @@
+# Copyright 2009-2011 Ram Rachum.
+# This program is distributed under the LGPL2.1 license.
+
+'''Utilities for testing GarlicSim.'''
+
diff --git a/misc/testing/zip/__init__.py b/misc/testing/zip/__init__.py
@@ -0,0 +1,5 @@
+# Copyright 2009-2011 Ram Rachum.
+# This program is distributed under the LGPL2.1 license.
+
+'''Utilities for testing GarlicSim from zip archives.'''
+
diff --git a/misc/testing/zip/make_zip.py b/misc/testing/zip/make_zip.py
@@ -29,14 +29,16 @@
 
 def zip_folder(folder, zip_path, ignored_patterns=[]):
     '''
-
-    note: creates a folder inside the zip with the same name of the original
+    Zip `folder` into a zip file specified by `zip_path`.
+    
+    Note: Creates a folder inside the zip with the same name of the original
     folder, in contrast to other implementation which put all of the files on
     the root level of the zip.
     
-    Doesn't put empty folders in the zip file.
+    `ignored_patterns` are fnmatch-style patterns specifiying file-paths to
+    ignore.
     
-    tododoc ignored_patterns, they're fnmatch style
+    Any empty sub-folders will be ignored.
     '''
     assert os.path.isdir(folder)
     source_folder = os.path.realpath(folder)
@@ -69,8 +71,12 @@ def zip_folder(folder, zip_path, ignored_patterns=[]):
                 zip_file.write(absolute_file_path, destination_file_path)
 
                 
-    
 def make_zip():
+    '''
+    Zip all the GarlicSim packages into zip archives in the `build` folder.
+    
+    This cleans any previous zip archives from the `build` folder.
+    '''
     ###########################################################################
     #                                                                         #
     module_path = os.path.realpath(os.path.split(__file__)[0])
diff --git a/misc/testing/zip/testing_utilities.py b/misc/testing/zip/testing_utilities.py
@@ -2,7 +2,7 @@
 # This program is distributed under the LGPL2.1 license.
 
 '''
-Defines utilities for testing GarlicSim from zip.
+Defines utilities for testing GarlicSim from a zip archive.
 
 Used by `run_tests.py` in the GarlicSim repo root.
 '''
