Convenience functions for callable hooks

[mediagoblin.git] / mediagoblin / errormiddleware.py

diff --git a/mediagoblin/errormiddleware.py b/mediagoblin/errormiddleware.py
index 2f14fdd5e747ae05bc0457e25942e794f5c8c29c..c6789f32d6b77f5c1db1bfbf0a5dd99978f8c95a 100644 (file)
--- a/mediagoblin/errormiddleware.py
+++ b/mediagoblin/errormiddleware.py
@@ -1,5 +1,5 @@
 # GNU MediaGoblin -- federated, autonomous media hosting
-# Copyright (C) 2011 Free Software Foundation, Inc
+# Copyright (C) 2011, 2012 MediaGoblin contributors.  See AUTHORS.
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU Affero General Public License as published by
@@ -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)