Documenting the setup_globals function.
authorChristopher Allan Webber <cwebber@dustycloud.org>
Sun, 19 Jun 2011 21:24:31 +0000 (16:24 -0500)
committerChristopher Allan Webber <cwebber@dustycloud.org>
Sun, 19 Jun 2011 21:24:31 +0000 (16:24 -0500)
mediagoblin/mg_globals.py

index b01be8d37182af77620e5fb5e2b1dc238bd895f6..739f44eed512c512a731470e7a03788a7bc3c70c 100644 (file)
@@ -44,6 +44,12 @@ app = None
 
 
 def setup_globals(**kwargs):
+    """
+    Sets up a bunch of globals in this module.
+
+    Takes the globals to setup as keyword arguments.  If globals are
+    specified that aren't set as variables above, then throw an error.
+    """
     from mediagoblin import mg_globals
 
     for key, value in kwargs.iteritems():