From 6a4ec66967de0f25e03a73d43e4c57b7295f561c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Neuh=C3=A4user?= Date: Sun, 25 Jul 2010 20:03:28 +0200 Subject: [PATCH] Added missing module docstrings --- sphinx/websupport/comments/__init__.py | 10 ++++++++++ sphinx/websupport/comments/db.py | 13 ++++++++++++- sphinx/websupport/comments/sqlalchemystorage.py | 11 +++++++++++ 3 files changed, 33 insertions(+), 1 deletion(-) diff --git a/sphinx/websupport/comments/__init__.py b/sphinx/websupport/comments/__init__.py index aca2ac351..1f1605184 100644 --- a/sphinx/websupport/comments/__init__.py +++ b/sphinx/websupport/comments/__init__.py @@ -1,3 +1,13 @@ +# -*- coding: utf-8 -*- +""" + sphinx.websupport.comments + ~~~~~~~~~~~~~~~~~~~~~~~~~~ + + Comments for the websupport package. + + :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS. + :license: BSD, see LICENSE for details. +""" class StorageBackend(object): def pre_build(self): diff --git a/sphinx/websupport/comments/db.py b/sphinx/websupport/comments/db.py index b73d6a5ae..db9ab7a80 100644 --- a/sphinx/websupport/comments/db.py +++ b/sphinx/websupport/comments/db.py @@ -1,3 +1,15 @@ +# -*- coding: utf-8 -*- +""" + sphinx.websupport.comments.db + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + SQLAlchemy table and mapper definitions used by the + :class:`sphinx.websupport.comments.SQLAlchemyStorage`. + + :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS. + :license: BSD, see LICENSE for details. +""" + from datetime import datetime from sqlalchemy import Column, Integer, Text, String, Boolean, ForeignKey,\ @@ -152,4 +164,3 @@ class ProposalVote(Base): self.value = value self.user_id = user_id self.proposal_id = proposal_id - diff --git a/sphinx/websupport/comments/sqlalchemystorage.py b/sphinx/websupport/comments/sqlalchemystorage.py index 8ee117502..312663c81 100644 --- a/sphinx/websupport/comments/sqlalchemystorage.py +++ b/sphinx/websupport/comments/sqlalchemystorage.py @@ -1,3 +1,14 @@ +# -*- coding: utf-8 -*- +""" + sphinx.websupport.comments.sqlalchemystorage + ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + + A SQLAlchemy storage backend. + + :copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS. + :license: BSD, see LICENSE for details. +""" + from datetime import datetime from sphinx.websupport.comments import StorageBackend