From 5014e7a75f02f8c707847122ff43b37064247a43 Mon Sep 17 00:00:00 2001
From: J08nY
Date: Thu, 22 Jun 2017 19:12:04 +0200
Subject: Document classes, methods, modules.

---
 src/mailman_pgp/database/__init__.py | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

(limited to 'src/mailman_pgp/database')

diff --git a/src/mailman_pgp/database/__init__.py b/src/mailman_pgp/database/__init__.py
index 950c6b1..bbb7840 100644
--- a/src/mailman_pgp/database/__init__.py
+++ b/src/mailman_pgp/database/__init__.py
@@ -15,7 +15,7 @@
 # You should have received a copy of the GNU General Public License along with
 # this program.  If not, see <http://www.gnu.org/licenses/>.
 
-""""""
+"""Common database functions and class."""
 
 from contextlib import contextmanager
 
@@ -31,6 +31,8 @@ from mailman_pgp.model.base import Base
 
 @public
 class Database:
+    """A SQLAlchemy database."""
+
     def __init__(self):
         url = config.get('db', 'url')
         self._url = expand(url, None, mailman_config.paths)
@@ -41,12 +43,24 @@ class Database:
 
     @property
     def session(self):
+        """
+        Get a scoped_session.
+
+        :return: A scoped session.
+        :rtype: scoped_session
+        """
         return self._scoped_session()
 
 
 @public
 @contextmanager
 def transaction():
+    """
+    A transaction context manager.
+
+    :return: A session for convenience.
+    :rtype: scoped_session
+    """
     try:
         yield config.db.session
     except:
@@ -58,4 +72,11 @@ def transaction():
 
 @public
 def query(cls):
+    """
+    A query helper.
+
+    :param cls: Class to query.
+    :return: A query on the class.
+    :rtype: sqlalchemy.orm.query.Query
+    """
     return config.db.session.query(cls)
-- 
cgit v1.2.3-70-g09d2