-

Ram Rachum · Ram Rachum · commit 57bb07d2e03f · 2011-02-13T21:55:20.000+02:00
diff --git a/garlicsim/setup.py b/garlicsim/setup.py
@@ -10,26 +10,58 @@
 import sys
 
 
+### Ensuring correct Python version: ##########################################
+#                                                                             #
 if sys.version_info[0] >= 3:
     raise Exception('This package is not compatible with Python 3.x. Use '
                     '`garlicsim_py3` instead.')
 if sys.version_info[1] <= 4:
     raise Exception('This package requires Python 2.5 and upwards. (Not '
                     'including 3.x).')
+#                                                                             #
+### Finished ensuring correct Python version. #################################
 
 
 def get_garlicsim_packages():
-    # tododoc all functions across all setup.py files
+    '''
+    Get all the packages in `garlicsim`.
+    
+    Returns something like:
+    
+        ['garlicsim', 'garlicsim.misc',
+        'garlicsim.general_misc.nifty_collections', ... ]
+        
+    '''
     return ['garlicsim.' + p for p in
             setuptools.find_packages('./garlicsim')] + \
            ['garlicsim']
 
+
 def get_test_garlicsim_packages():
+    '''
+    Get all the packages in `test_garlicsim`.
+    
+    Returns something like:
+    
+        ['test_garlicsim', 'test_garlicsim.test_misc',
+        'test_garlicsim.test_general_misc.test_nifty_collections', ... ]
+        
+    '''
     return ['test_garlicsim.' + p for p in
             setuptools.find_packages('./test_garlicsim')] + \
            ['test_garlicsim']
 
+
 def get_packages():
+    '''
+    Get all the packages in `garlicsim` and `test_garlicsim`.
+    
+    Returns something like:
+    
+        ['test_garlicsim', 'garlicsim', 'garlicsim.misc',
+        'test_garlicsim.test_general_misc.test_nifty_collections', ... ]
+        
+    '''
     return get_garlicsim_packages() + get_test_garlicsim_packages()
 
 
@@ -44,7 +76,7 @@ def get_packages():
 '''
 
 my_classifiers = [
-    'Development Status :: 3 - Alpha',
+    'Development Status :: 4 - Beta',
     'Intended Audience :: Science/Research',
     ('License :: OSI Approved :: GNU Library or Lesser General '
      'Public License (LGPL)'),
diff --git a/garlicsim_lib/setup.py b/garlicsim_lib/setup.py
@@ -10,19 +10,60 @@
 import setuptools
 
 
+### Ensuring correct Python version: ##########################################
+#                                                                             #
 if sys.version_info[0] >= 3:
     raise Exception('This package is not compatible with Python 3.x. Use '
                     '`garlicsim_lib_py3` instead.')
 if sys.version_info[1] <= 4:
     raise Exception('This package requires Python 2.5 and upwards. (Not '
                     'including 3.x).')
+#                                                                             #
+### Finished ensuring correct Python version. #################################
 
 
-def get_packages():
+def get_garlicsim_lib_packages():
+    '''
+    Get all the packages in `garlicsim_lib`.
+    
+    Returns something like:
+    
+        ['garlicsim_lib', 'garlicsim_lib.simpacks',
+        'garlicsim_lib.simpacks.life', ... ]
+        
+    '''
     return ['garlicsim_lib.' + p for p in
             setuptools.find_packages('./garlicsim_lib')] + \
            ['garlicsim_lib']
 
+
+def get_test_garlicsim_lib_packages():
+    '''
+    Get all the packages in `test_garlicsim_lib`.
+    
+    Returns something like:
+    
+        ['test_garlicsim_lib', 'test_garlicsim_lib.test_simpacks', ...]
+        
+    '''
+    return ['test_garlicsim_lib.' + p for p in
+            setuptools.find_packages('./test_garlicsim_lib')] + \
+           ['test_garlicsim_lib']
+
+
+def get_packages():
+    '''
+    Get all the packages in `garlicsim_lib` and `test_garlicsim_lib`.
+    
+    Returns something like:
+    
+        ['test_garlicsim_lib', 'garlicsim_lib', 'garlicsim_lib.simpacks',
+        'test_garlicsim_lib.test_simpacks', ... ]
+        
+    '''
+    return get_garlicsim_lib_packages() + get_test_garlicsim_lib_packages()
+
+
 my_long_description = \
 '''\
 A collection of GarlicSim simulation packages, for various scientific fields.
diff --git a/garlicsim_wx/setup.py b/garlicsim_wx/setup.py
@@ -11,11 +11,15 @@
 import setuptools
 
 
+### Ensuring correct Python version: ##########################################
+#                                                                             #
 if sys.version_info[0] >= 3:
     raise Exception('This package is not compatible with Python 3.x.')
 if sys.version_info[1] <= 4:
     raise Exception('This package requires Python 2.5 and upwards. (Not '
                     'including 3.x).')
+#                                                                             #
+### Finished ensuring correct Python version. #################################
 
 
 if 'py2exe' in sys.argv:
