-

Ram Rachum · Ram Rachum · commit 43bbf725d589 · 2011-02-16T17:53:56.000+02:00
diff --git a/garlicsim/test_garlicsim/test_asynchronous_crunching/test_crunchers/test_pi_cloud_cruncher.py b/garlicsim/test_garlicsim/test_asynchronous_crunching/test_crunchers/test_pi_cloud_cruncher.py
@@ -8,16 +8,15 @@
 
 
 def test_pi_cloud_cruncher():
-    
+    '''Test the `PiCloudCruncher` placeholder.'''
     # Allowing either `TypeError` or `NotImplementedError`:
     try:
         nose.tools.assert_raises(TypeError, PiCloudCruncher)
     except Exception:
         nose.tools.assert_raises(NotImplementedError, PiCloudCruncher)
     
         
-    from test_garlicsim.test_misc.test_simpack_grokker.simpacks import \
-        simpack
+    from test_garlicsim.test_misc.test_simpack_grokker.simpacks import simpack
     simpack_grokker = garlicsim.misc.SimpackGrokker(simpack)
     
     availability = \
diff --git a/garlicsim/test_garlicsim/test_asynchronous_crunching/test_endable/test_endable.py b/garlicsim/test_garlicsim/test_asynchronous_crunching/test_endable/test_endable.py
@@ -40,7 +40,7 @@ def test_endable():
     simpacks = import_tools.import_all(simpacks_package).values()
     
     # Making sure that we didn't miss any simpack by counting the number of
-    # sub-folders in the `simpacks_package` folders:
+    # sub-folders in the `simpacks` folder:
     simpacks_dir = \
         os.path.dirname(simpacks_package.__file__)
     assert len(path_tools.list_sub_folders(simpacks_dir)) == \
diff --git a/garlicsim/test_garlicsim/test_asynchronous_crunching/test_on_the_fly/tests.py b/garlicsim/test_garlicsim/test_asynchronous_crunching/test_on_the_fly/tests.py
@@ -36,7 +36,7 @@ def test():
     simpacks = import_tools.import_all(simpacks_package).values()
     
     # Making sure that we didn't miss any simpack by counting the number of
-    # sub-folders in the `simpacks_package` folders:
+    # sub-folders in the `simpacks` folder:
     simpacks_dir = \
         os.path.dirname(simpacks_package.__file__)
     assert len(path_tools.list_sub_folders(simpacks_dir)) == \
diff --git a/garlicsim/test_garlicsim/test_asynchronous_crunching/tests.py b/garlicsim/test_garlicsim/test_asynchronous_crunching/tests.py
@@ -33,7 +33,7 @@ def test():
     simpacks = import_tools.import_all(simpacks_package).values()
     
     # Making sure that we didn't miss any simpack by counting the number of
-    # sub-folders in the `simpacks_package` folders:
+    # sub-folders in the `simpacks` folder:
     simpacks_dir = \
         os.path.dirname(simpacks_package.__file__)
     assert len(path_tools.list_sub_folders(simpacks_dir)) == \
diff --git a/garlicsim/test_garlicsim/test_doc/test_tutorial_2/test.py b/garlicsim/test_garlicsim/test_doc/test_tutorial_2/test.py
@@ -100,7 +100,7 @@ def test():
                                                                       
             state_module_path = os.path.join(simpack_path, 'state.py')
             
-            check_module_was_copied_with_correct_newlines(
+            assert_module_was_copied_with_correct_newlines(
                 state_module_path,
                 garlicsim.scripts.simpack_template.simpack_name.state
             )
@@ -161,8 +161,14 @@ def get_end_balance():
         shutil.rmtree(temp_dir)
     
         
-def check_module_was_copied_with_correct_newlines(destination_path,
-                                                  source_module):
+def assert_module_was_copied_with_correct_newlines(destination_path,
+                                                   source_module):
+    '''
+    Assert `source_module` was copied to `destination_path` with good newlines.
+    
+    e.g, on Linux the file should use '\n' for newlines, on Windows it should
+    use '\r\n'.
+    '''
     
     assert os.path.isfile(destination_path)
     assert isinstance(source_module, types.ModuleType)
