- docstring clean ups

bzr-revno: 1696

openlp/plugins/remotes/lib/httpserver.py

@@ -150,13 +150,11 @@ class HttpResponse(object):
 
 class HttpServer(object):
     """
-    Ability to control OpenLP via a webbrowser
+    Ability to control OpenLP via a web browser.
-    e.g. http://localhost:4316/send/slidecontroller_live_next
-          http://localhost:4316/send/alerts_text?q=your%20alert%20text
     """
     def __init__(self, plugin):
         """
-        Initialise the httpserver, and start the server
+        Initialise the httpserver, and start the server.
         """
         log.debug(u'Initialise httpserver')
         self.plugin = plugin
@@ -170,9 +168,9 @@ class HttpServer(object):
 
     def start_tcp(self):
         """
-        Start the http server, use the port in the settings default to 4316
+        Start the http server, use the port in the settings default to 4316.
         Listen out for slide and song changes so they can be broadcast to
-        clients. Listen out for socket connections
+        clients. Listen out for socket connections.
         """
         log.debug(u'Start TCP server')
         port = QtCore.QSettings().value(
@@ -195,20 +193,20 @@ class HttpServer(object):
 
     def slide_change(self, row):
         """
-        Slide change listener. Store the item and tell the clients
+        Slide change listener. Store the item and tell the clients.
         """
         self.current_slide = row
 
     def item_change(self, items):
         """
-        Item (song) change listener. Store the slide and tell the clients
+        Item (song) change listener. Store the slide and tell the clients.
         """
         self.current_item = items[0]
 
     def new_connection(self):
         """
         A new http connection has been made. Create a client object to handle
-        communication
+        communication.
         """
         log.debug(u'new http connection')
         socket = self.server.nextPendingConnection()
@@ -225,15 +223,16 @@ class HttpServer(object):
 
     def close(self):
         """
-        Close down the http server
+        Close down the http server.
         """
         log.debug(u'close http server')
         self.server.close()
 
+
 class HttpConnection(object):
     """
     A single connection, this handles communication between the server
-    and the client
+    and the client.
     """
     def __init__(self, parent, socket):
         """
@@ -287,9 +286,12 @@ class HttpConnection(object):
         """
         self.template_vars = {
             'app_title': translate('RemotePlugin.Mobile', 'OpenLP 2.0 Remote'),
-            'stage_title': translate('RemotePlugin.Mobile', 'OpenLP 2.0 Stage View'),
+            'stage_title': translate('RemotePlugin.Mobile',
-            'service_manager': translate('RemotePlugin.Mobile', 'Service Manager'),
+                'OpenLP 2.0 Stage View'),
-            'slide_controller': translate('RemotePlugin.Mobile', 'Slide Controller'),
+            'service_manager': translate('RemotePlugin.Mobile',
+                'Service Manager'),
+            'slide_controller': translate('RemotePlugin.Mobile',
+                'Slide Controller'),
             'alerts': translate('RemotePlugin.Mobile', 'Alerts'),
             'search': translate('RemotePlugin.Mobile', 'Search'),
             'back': translate('RemotePlugin.Mobile', 'Back'),
@@ -301,7 +303,8 @@ class HttpConnection(object):
             'text': translate('RemotePlugin.Mobile', 'Text'),
             'show_alert': translate('RemotePlugin.Mobile', 'Show Alert'),
             'go_live': translate('RemotePlugin.Mobile', 'Go Live'),
-            'add_to_service': translate('RemotePlugin.Mobile', 'Add To Service'),
+            'add_to_service': translate('RemotePlugin.Mobile',
+                'Add to Service'),
             'no_results': translate('RemotePlugin.Mobile', 'No Results'),
             'options': translate('RemotePlugin.Mobile', 'Options')
         }
@@ -397,7 +400,7 @@ class HttpConnection(object):
                 if self.parent.current_item else u''
         }
         return HttpResponse(json.dumps({u'results': result}),
-             {u'Content-Type': u'application/json'})
+            {u'Content-Type': u'application/json'})
 
     def display(self, action):
         """
@@ -483,10 +486,11 @@ class HttpConnection(object):
 
     def pluginInfo(self, action):
         """
-        Return plugin related information, based on the action
+        Return plugin related information, based on the action.
 
-        ``action`` - The action to perform
+        ``action``
-            if 'search' return a list of plugin names which support search
+            The action to perform. If *search* return a list of plugin names
+            which support search.
         """
         if action == u'search':
             searches = []
@@ -501,10 +505,10 @@ class HttpConnection(object):
 
     def search(self, type):
         """
-        Return a list of items that match the search text
+        Return a list of items that match the search text.
 
         ``type``
-        The plugin name to search in.
+            The plugin name to search in.
         """
         text = json.loads(self.url_params[u'data'][0])[u'request'][u'text']
         plugin = self.parent.plugin.pluginManager.get_plugin_by_name(type)
@@ -528,7 +532,7 @@ class HttpConnection(object):
 
     def add_to_service(self, type):
         """
-        Add item of type ``type`` to the end of the service
+        Add item of type ``type`` to the end of the service.
         """
         id = json.loads(self.url_params[u'data'][0])[u'request'][u'id']
         plugin = self.parent.plugin.pluginManager.get_plugin_by_name(type)