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/model/base.py | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) (limited to 'src/mailman_pgp/model/base.py') diff --git a/src/mailman_pgp/model/base.py b/src/mailman_pgp/model/base.py index 646bb7d..f5d8e77 100644 --- a/src/mailman_pgp/model/base.py +++ b/src/mailman_pgp/model/base.py @@ -15,7 +15,7 @@ # You should have received a copy of the GNU General Public License along with # this program. If not, see . -"""""" +"""Base class for all models.""" from public import public from sqlalchemy.ext.declarative import as_declarative @@ -26,9 +26,16 @@ from mailman_pgp.database import query @public @as_declarative() class Base: + """Custom declarative base.""" @classmethod def query(cls): + """ + A query helper. + + :return: A query on class. + :rtype: sqlalchemy.orm.query.Query + """ return query(cls) -- cgit v1.2.3-70-g09d2