openlp-core team mailing list archive

[Jon Tibble <meths@xxxxxxxxxxxxxx>]

Jon Tibble has proposed merging lp:~meths/openlp/docs into lp:openlp.

Requested reviews:
  OpenLP Core (openlp-core)


Fill in the empty docstrings
-- 
https://code.launchpad.net/~meths/openlp/docs/+merge/30736
Your team OpenLP Core is requested to review the proposed merge of lp:~meths/openlp/docs into lp:openlp.

=== modified file 'openlp/plugins/presentations/presentationplugin.py'
--- openlp/plugins/presentations/presentationplugin.py	2010-07-21 22:46:25 +0000
+++ openlp/plugins/presentations/presentationplugin.py	2010-07-23 02:24:49 +0000
@@ -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
 

=== modified file 'openlp/plugins/songs/lib/olpimport.py'
--- openlp/plugins/songs/lib/olpimport.py	2010-07-21 13:41:10 +0000
+++ openlp/plugins/songs/lib/olpimport.py	2010-07-23 02:24:49 +0000
@@ -70,11 +70,18 @@
 
 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 @@
 
     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()