Add doc for session_wrapper.

[dak.git] / daklib / dbconn.py

diff --git a/daklib/dbconn.py b/daklib/dbconn.py
index 8ee9076874d09a0d785924cb4bf3eb891e9b41b9..fb322aeaf674e22fa455c6af95c84e004f8d8f78 100755 (executable)
--- a/daklib/dbconn.py
+++ b/daklib/dbconn.py
@@ -59,6 +59,12 @@ __all__ = ['IntegrityError', 'SQLAlchemyError']
 ################################################################################
 
 def session_wrapper(fn):
+    """
+    Wrapper around common ".., session=None):" handling. If the wrapped
+    function is called without passing 'session', we create a local one
+    and destroy it when the function ends.
+    """
+
     def wrapped(*args, **kwargs):
         private_transaction = False
         session = kwargs.get('session')