Added a docstring to mgoblin_error_middleware
authorChristopher Allan Webber <cwebber@dustycloud.org>
Sun, 21 Aug 2011 05:24:47 +0000 (00:24 -0500)
committerChristopher Allan Webber <cwebber@dustycloud.org>
Sun, 21 Aug 2011 05:24:47 +0000 (00:24 -0500)
mediagoblin/errormiddleware.py

index 2f14fdd5e747ae05bc0457e25942e794f5c8c29c..352dc891c6bbf1c7ed977c37269a198e4406032a 100644 (file)
@@ -49,5 +49,12 @@ MGOBLIN_ERROR_MESSAGE = """\
 
 
 def mgoblin_error_middleware(app, global_conf, **kw):
+    """
+    MediaGoblin wrapped error middleware.
+
+    This is really just wrapping the error middleware from Paste.
+    It should take all of Paste's default options, so see:
+      http://pythonpaste.org/modules/exceptions.html
+    """
     kw['error_message'] = MGOBLIN_ERROR_MESSAGE
     return make_error_middleware(app, global_conf, **kw)