DocStrings

This commit is contained in:
Jon Tibble 2010-07-22 01:28:56 +01:00
parent 5178172c80
commit d2372850e4
2 changed files with 13 additions and 3 deletions

View File

@ -22,7 +22,10 @@
# with this program; if not, write to the Free Software Foundation, Inc., 59 # # with this program; if not, write to the Free Software Foundation, Inc., 59 #
# Temple Place, Suite 330, Boston, MA 02111-1307 USA # # 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 os
import logging import logging

View File

@ -70,11 +70,18 @@ class OldTopic(BaseModel):
class OpenLPSongImport(object): 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): 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.master_manager = master_manager
self.import_source = source_db self.import_source = source_db
@ -82,7 +89,7 @@ class OpenLPSongImport(object):
def import_source_v2_db(self): def import_source_v2_db(self):
""" """
Run the import for an OpenLP version 2 song database.
""" """
engine = create_engine(self.import_source) engine = create_engine(self.import_source)
source_meta = MetaData() source_meta = MetaData()