-

Ram Rachum · Ram Rachum · commit b92273d10565 · 2011-02-17T00:11:33.000+02:00
diff --git a/garlicsim/test_garlicsim/__init__.py b/garlicsim/test_garlicsim/__init__.py
@@ -91,5 +91,6 @@ def exists(module_name):
 
 
 def invoke_nose(arguments=_default_nose_arguments):
+    '''Start Nose using this `test_garlicsim` test package.'''
     nose.run(defaultTest='test_garlicsim', argv=([sys.argv[0]] + arguments))
     
diff --git a/garlicsim/test_garlicsim/test_misc/test_simpack_grokker/test_problematic_simpacks/test_problematic_simpacks.py b/garlicsim/test_garlicsim/test_misc/test_simpack_grokker/test_problematic_simpacks/test_problematic_simpacks.py
@@ -29,7 +29,7 @@ def test_simpacks():
     simpacks = import_tools.import_all(problematic_simpacks_package).values()
     
     # Making sure that we didn't miss any simpack by counting the number of
-    # sub-folders in the `problematic_simpacks_package` folders:
+    # sub-folders in the `simpacks` folder:
     simpacks_dir = \
         os.path.dirname(problematic_simpacks_package.__file__)
     assert len(
diff --git a/garlicsim/test_garlicsim/test_misc/test_simpack_grokker/test_simpack_grokker.py b/garlicsim/test_garlicsim/test_misc/test_simpack_grokker/test_simpack_grokker.py
@@ -23,7 +23,7 @@ def test_simpacks():
     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)) == \
            len(simpacks)
diff --git a/garlicsim/test_garlicsim/test_misc/test_step_profile/test_build_parser.py b/garlicsim/test_garlicsim/test_misc/test_step_profile/test_build_parser.py
@@ -1,6 +1,8 @@
 # Copyright 2009-2011 Ram Rachum.
 # This program is distributed under the LGPL2.1 license.
 
+'''Testing module for `garlicsim.misc.StepProfile.build_parser`.'''
+
 import nose.tools
 
 import garlicsim
@@ -12,15 +14,14 @@
 
 
 def test():
+    '''Test the basic workings of `StepProfile.build_parser`.'''
+    
     verify_simpack_settings(simpack)
     simpack_grokker = garlicsim.misc.SimpackGrokker(simpack)
     
-    parse = \
-        StepProfile.build_parser(simpack.State.step)
-    alternate_parse = \
-        StepProfile.build_parser(simpack.State.alternate_step)
-    none_parse = \
-        StepProfile.build_parser(None)
+    parse = StepProfile.build_parser(simpack.State.step)
+    alternate_parse = StepProfile.build_parser(simpack.State.alternate_step)
+    none_parse = StepProfile.build_parser(None)
     
     
     default_step_profile = parse()
@@ -45,8 +46,6 @@ def test():
     
     assert different_step_profile != step_profile
     
-    
-    
 
     alternate_step_profile = alternate_parse()
     assert alternate_step_profile == alternate_parse(z=3) == \
diff --git a/garlicsim_lib/setup.py b/garlicsim_lib/setup.py
@@ -66,7 +66,7 @@ def get_packages():
 
 my_long_description = \
 '''\
-A collection of GarlicSim simulation packages, for various scientific fields.
+Collection of GarlicSim simulation packages, for various scientific fields.
 
 To be used with `garlicsim` and possibly `garlicsim_wx`.
 
diff --git a/garlicsim_lib/test_garlicsim_lib/__init__.py b/garlicsim_lib/test_garlicsim_lib/__init__.py
@@ -89,6 +89,7 @@ def exists(module_name):
 
 
 def invoke_nose(arguments=_default_nose_arguments):
+    '''Start Nose using this `test_garlicsim_lib` test package.'''
     nose.run(defaultTest='test_garlicsim_lib',
              argv=([sys.argv[0]] + arguments))
     
diff --git a/garlicsim_wx/garlicsim_wx/misc/icon_bundle/__init__.py b/garlicsim_wx/garlicsim_wx/misc/icon_bundle/__init__.py
@@ -1,23 +1,23 @@
-# tododoc: this module looks like crap
+# Copyright 2009-2011 Ram Rachum. No part of this program may be used, copied
+# or distributed without explicit written permission from Ram Rachum.
+
+'''Defines an icon bundle for GarlicSim.'''
+
+
 import pkg_resources
 
 import wx
 
+from garlicsim.general_misc import caching
 
 
-_icon_bundle = None
-
+@caching.cache()
 def get_icon_bundle():
-    
-    global _icon_bundle
-    
-    if _icon_bundle:
-        return _icon_bundle
+    '''Get GarlicSim's icon bundle.'''
 
     from . import images as __images_package
     images_package = __images_package.__name__
 
-
     icons = []
     for size in [16, 24, 32, 48, 96, 128, 256]:
         file_name = 'icon%s.png' % str(size)
@@ -38,10 +38,9 @@ def get_icon_bundle():
         # todo: should probably be loading the bitmaps from the .ico file, to
         # save on storing all those PNGs.
                     
-    
-    _icon_bundle = wx.IconBundle()
+    icon_bundle = wx.IconBundle()
     
     for icon in icons:
-        _icon_bundle.AddIcon(icon)
+        icon_bundle.AddIcon(icon)
     
-    return _icon_bundle
+    return icon_bundle
diff --git a/garlicsim_wx/test_garlicsim_wx/__init__.py b/garlicsim_wx/test_garlicsim_wx/__init__.py
@@ -89,5 +89,6 @@ def exists(module_name):
 
 
 def invoke_nose(arguments=_default_nose_arguments):
+    '''Start Nose using this `test_garlicsim_wx` test package.'''
     nose.run(defaultTest='test_garlicsim_wx', argv=([sys.argv[0]] + arguments))
     

Original file line number	Diff line number	Diff line change
`@@ -91,5 +91,6 @@ def exists(module_name):`
`91`	`91`
`92`	`92`
`93`	`93`	`def invoke_nose(arguments=_default_nose_arguments):`
	`94`	+ '''Start Nose using this `test_garlicsim` test package.'''
`94`	`95`	`nose.run(defaultTest='test_garlicsim', argv=([sys.argv[0]] + arguments))`
`95`	`96`
Original file line number	Diff line number	Diff line change
`@@ -89,5 +89,6 @@ def exists(module_name):`
`89`	`89`
`90`	`90`
`91`	`91`	`def invoke_nose(arguments=_default_nose_arguments):`
	`92`	+ '''Start Nose using this `test_garlicsim_wx` test package.'''
`92`	`93`	`nose.run(defaultTest='test_garlicsim_wx', argv=([sys.argv[0]] + arguments))`
`93`	`94`