changeset 902:e966d5ab8103

added comment to record_versions
author James Bergstra <bergstrj@iro.umontreal.ca>
date Mon, 08 Mar 2010 17:56:51 -0500
parents a88c1746b068
children 3b53ed688747
files pylearn/version.py
diffstat 1 files changed, 7 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/pylearn/version.py	Wed Feb 24 13:55:33 2010 -0500
+++ b/pylearn/version.py	Mon Mar 08 17:56:51 2010 -0500
@@ -7,6 +7,13 @@
 _cache = dict()
 
 def record_versions(results, modules, prefix='version_'):
+    """Bizarre version-recording function... 
+
+       For each module in `modules` it executes
+       result.<prefix><module.__name__> = import_id(module.__name)
+
+       :returns: None
+    """
     for module in modules:
         setattr(results, prefix+module.__name__, import_id(module.__name__))