From d2372850e4779204f18211cd8a4ebab0be52d30f Mon Sep 17 00:00:00 2001 From: Jon Tibble Date: Thu, 22 Jul 2010 01:28:56 +0100 Subject: [PATCH] DocStrings --- openlp/plugins/presentations/presentationplugin.py | 5 ++++- openlp/plugins/songs/lib/olpimport.py | 11 +++++++++-- 2 files changed, 13 insertions(+), 3 deletions(-) diff --git a/openlp/plugins/presentations/presentationplugin.py b/openlp/plugins/presentations/presentationplugin.py index 50784ed51..58e033ae6 100644 --- a/openlp/plugins/presentations/presentationplugin.py +++ b/openlp/plugins/presentations/presentationplugin.py @@ -22,7 +22,10 @@ # with this program; if not, write to the Free Software Foundation, Inc., 59 # # Temple Place, Suite 330, Boston, MA 02111-1307 USA # ############################################################################### - +""" +The :mod:`presentationplugin` module provides the ability for OpenLP to display +presentations from a variety of document formats. +""" import os import logging diff --git a/openlp/plugins/songs/lib/olpimport.py b/openlp/plugins/songs/lib/olpimport.py index e4a58277c..5056f6534 100644 --- a/openlp/plugins/songs/lib/olpimport.py +++ b/openlp/plugins/songs/lib/olpimport.py @@ -70,11 +70,18 @@ class OldTopic(BaseModel): class OpenLPSongImport(object): """ - + The :class:`OpenLPSongImport` class provides OpenLP with the ability to + import song databases from other installations of OpenLP. """ def __init__(self, master_manager, source_db): """ + Initialise the import. + ``master_manager`` + The song manager for the running OpenLP installation. + + ``source_db`` + The database providing the data to import. """ self.master_manager = master_manager self.import_source = source_db @@ -82,7 +89,7 @@ class OpenLPSongImport(object): def import_source_v2_db(self): """ - + Run the import for an OpenLP version 2 song database. """ engine = create_engine(self.import_source) source_meta = MetaData()