Docstrings

bzr-revno: 898

openlp/core/lib/renderer.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:`renderer` module enables OpenLP to take the input from plugins and
+format it for the output display.
+"""
 import logging
 
 from PyQt4 import QtGui, QtCore

openlp/plugins/alerts/__init__.py

@@ -24,5 +24,5 @@
 ###############################################################################
 """
 The :mod:`alerts` module provides the Alerts plugin for producing impromptu
-on-screen announcements during a service
+on-screen announcements during a service.
 """

openlp/plugins/bibles/__init__.py

@@ -23,6 +23,6 @@
 # Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
 ###############################################################################
 """
-The :mod:`bibles' modules provides the Bible plugin to enable OpenLP to display
-scripture
+The :mod:`bibles' module provides the Bible plugin to enable OpenLP to display
+scripture.
 """

openlp/plugins/custom/__init__.py

@@ -22,3 +22,8 @@
 # with this program; if not, write to the Free Software Foundation, Inc., 59  #
 # Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
 ###############################################################################
+"""
+The :mod:`custom` module provides the Custom plugin which allows custom,
+themed, text based items to be displayed without having to misuse another item
+type.
+"""

openlp/plugins/images/__init__.py

@@ -22,3 +22,7 @@
 # with this program; if not, write to the Free Software Foundation, Inc., 59  #
 # Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
 ###############################################################################
+"""
+The :mod:`images` module provides the Images plugin.  The Images plugin
+provides the facility to display images from OpenLP.
+"""

openlp/plugins/media/__init__.py

@@ -22,3 +22,9 @@
 # with this program; if not, write to the Free Software Foundation, Inc., 59  #
 # Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
 ###############################################################################
+"""
+The :mod:`media` module provides the Media plugin which allows OpenLP to
+display videos.  The media supported depends not only on the Python support
+but also extensively on the codecs installed on the underlying operating system
+being picked up and usable by Python.
+"""

openlp/plugins/presentations/__init__.py

@@ -22,3 +22,7 @@
 # with this program; if not, write to the Free Software Foundation, Inc., 59  #
 # Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
 ###############################################################################
+"""
+The :mod:`presentations` module provides the Presentations plugin which allows
+OpenLP to show presentations from most popular presentation packages.
+"""

openlp/plugins/remotes/__init__.py

@@ -22,3 +22,7 @@
 # with this program; if not, write to the Free Software Foundation, Inc., 59  #
 # Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
 ###############################################################################
+"""
+The :mod:`remotes` plugin allows OpenLP to be controlled from another machine
+over a network connection.
+"""

openlp/plugins/songs/__init__.py

@@ -22,3 +22,7 @@
 # with this program; if not, write to the Free Software Foundation, Inc., 59  #
 # Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
 ###############################################################################
+"""
+The :mod:`songs` module provides the Songs plugin.  The Songs plugin provides
+the main lyric projection function of OpenLP.
+"""

openlp/plugins/songusage/__init__.py

@@ -22,3 +22,8 @@
 # with this program; if not, write to the Free Software Foundation, Inc., 59  #
 # Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
 ###############################################################################
+"""
+The :mod:`songusage` module contains the Song Usage plugin.  The Song Usage
+plugin provides auditing capabilities for reporting the songs you are using to
+copyright license organisations.
+"""

openlp/plugins/songusage/forms/songusagedetailform.py

@@ -42,7 +42,7 @@ class SongUsageDetailForm(QtGui.QDialog, Ui_SongUsageDetailDialog):
 
     def __init__(self, parent=None):
         """
-        Constructor
+        Initialise the form
         """
         QtGui.QDialog.__init__(self, None)
         self.parent = parent

openlp/plugins/songusage/lib/manager.py

@@ -22,7 +22,9 @@
 # with this program; if not, write to the Free Software Foundation, Inc., 59  #
 # Temple Place, Suite 330, Boston, MA 02111-1307 USA                          #
 ###############################################################################
-
+"""
+The :mod:`manager` module provides song usage specific database query code
+"""
 import logging
 
 from sqlalchemy.exceptions import InvalidRequestError