Merge lp:~joelmontes01/gwibber/Better_Docsting_PEP_257 into lp:gwibber

[Joel Montes de Oca]

Submitting my edits of the docsctrings in the plugin files. If there's no problems with the edits and it's approved, I'll continue editing the docstrings within the GTK files. Nature of edits: converted current docstrings to Python's PEP 257 styles.

[Ken VanDine (ken-vandine)]

This looks good, thanks!

review: Approve

[Joel Montes de Oca (joelmontes01)]

Awesome! I'm glad it helped. :)

=== modified file 'gwibber/microblog/plugins/facebook/__init__.py'
--- gwibber/microblog/plugins/facebook/__init__.py	2012-05-23 14:02:10 +0000
+++ gwibber/microblog/plugins/facebook/__init__.py	2012-06-12 20:30:26 +0000
@@ -65,6 +65,7 @@
 
     First, look for the 'updated_time' key in the data, falling back to
     'created_time' if the former is missing.
+    
     """
     # Convert from an ISO 8601 format time string to a Epoch timestamp.
     # Assume standard ISO 8601 'T' separator, no microseconds, and naive
@@ -75,23 +76,30 @@
 
 
 class Client:
-  """ Client: The Client class is responsible for querying Facebook and turning the data obtained
-  into data that Gwibber can understand.  Facebook uses a version of oauth for security.
+  """Query Facebook and convert data.
+  
+  The Client class is responsible for querying Facebook and turning the data obtained
+  into data that Gwibber can understand. Facebook uses a version of oauth for security.
   Tokens have already been obtained when the account was set up in Gwibber and are used to 
   authenticate when getting data.
+  
   """
   def __init__(self, acct):
     self.account = acct
     self.user_id = acct.get("uid", None)
 
   def _check_error(self, data):
-    """Checks to ensure the data obtained by Facebook is on the correct form
+    """Checks if data is from the correct form.
+    
+    Checks to ensure the data obtained by Facebook is on the correct form.
     If not, an error is logged in gwibber.log
-    Args:
-      data: A data structure obtained from Foursquare
+    
+    Arguments: 
+    data -- A data structure obtained from Foursquare
+    
     Returns:
-      True if data is contains 'error' or is not a dict.
-      Otherwise, False
+    True if data is contains an error or is not a dictionary, otherwise, False.
+      
     """
     if isinstance(data, dict):
       if data.has_key("error"):
@@ -102,14 +110,17 @@
     return True
     
   def _get(self, operation, post=False, single=False, **args):
-    """ Establishes a connection with Facebook and gets the data requested
-    Args: 
-      operation: The end of the url to look up on Facebook
-      post: True is this is a send, False if a recieve (False by default)
-      single: True if a single checkin is requested, False if multiple (False by default)
-      **args: Args to be added to the url when accessed. 
+    """Establishes a connection with Facebook and gets the data requested.
+    
+    Arguments: 
+    operation -- The end of the URL to look up on Facebook
+    post -- True is this is a send, False if a receive (False by default)
+    single -- True if a single checkin is requested, False if multiple (False by default)
+    **args -- Arguments to be added to the URL when accessed. 
+    
     Returns:
-      A list of facebook objects
+    A list of Facebook objects.
+    
     """
     if not self.user_id or "access_token" not in self.account:
       logstr = """%s: %s - %s""" % (PROTOCOL_INFO["name"], _("Authentication failed"), "Auth needs updating")
@@ -143,11 +154,14 @@
     return data
 
   def _sender(self, data):
-    """ Parses the sender of the facebook object
-    Args:
-      data: A facebook object
+    """Parses the sender of the Facebook object.
+    
+    Arguments:
+    data -- A Facebook object
+    
     Returns:
-      A sender object in a format compatible with gwibber's database
+    A sender object in a format compatible with Gwibber's database.
+    
     """
     sender = {
       "name": data["name"],
@@ -159,11 +173,14 @@
     return sender
   
   def _message(self, data):
-    """ Parses a facebook object
-    Args:
-      data: A facebook object
+    """Parses a Facebook object.
+    
+    Arguments:
+    data -- A Facebook object
+    
     Returns:
-      A facebook object in a format compatible with gwibber's database
+    A Facebook object in a format compatible with Gwibber's database.
+    
     """
     if type(data) != dict:
       logger.error("Cannot parse message data: %s", str(data))
@@ -302,11 +319,14 @@
     return getattr(self, opname)(**args)
 
   def receive(self, since=None):
-    """ Gets a list of facebook objects and add them to the database.  
-    Args: 
-      since: the time to get facebook objects from
+    """Gets a list of Facebook objects and add them to the database.  
+    
+    Arguments: 
+    since -- The time to get Facebook objects from
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by the parse function
+    A list of Gwibber compatible objects which have been parsed by the parse function.
+    
     """
     if since is None:
       since = (datetime.now() - timedelta(hours=240.0)).isoformat()
@@ -327,11 +347,14 @@
     else: return 
 
   def delete(self, message):
-    """ Deletes a specified message from facebook
-    Args: 
-      message: a gwibber compatible message object (from gwibber's database)
+    """Deletes a specified message from Facebook.
+    
+    Arguments: 
+    message -- A Gwibber compatible message object (from Gwibber's database)
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     result = self._get("stream.remove", post_id=message["mid"])
     if not result:
@@ -340,11 +363,14 @@
     return []
 
   def like(self, message):
-    """ Likes a specified message on facebook
-    Args: 
-      message: a gwibber compatible message object (from gwibber's database)
+    """Likes a specified message on Facebook.
+    
+    Arguments: 
+    message -- a Gwibber compatible message object (from Gwibber's database)
+    
     Returns:
-      The liked message
+    The liked message
+    
     """
     result = self._get(message["mid"] + "/likes", post=True)
     if not result:
@@ -354,11 +380,14 @@
     return data
 
   def unlike(self, message):
-    """ Unlikes a specified message on facebook
-    Args: 
-      message: a gwibber compatible message object (from gwibber's database)
+    """Unlikes a specified message on Facebook.
+    
+    Arguments: 
+    message -- A Gwibber compatible message object (from Gwibber's database)
+    
     Returns:
-      The unliked message
+    The unliked message
+    
     """
     result = self._get(message["mid"] + "/likes", post=True, method="delete")
     if not result:
@@ -368,11 +397,14 @@
     return data
 
   def send(self, message):
-    """ Sends a message to facebook
-    Args: 
-      message: The text of the message
+    """Sends a message to Facebook.
+    
+    Arguments: 
+    message -- The text of the message
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     result = self._get("me/feed", message=message, status_includes_verb=True, post=True)
     if not result:
@@ -381,12 +413,15 @@
     return []
 
   def send_thread(self, message, target):
-    """ Sends a message to facebook as a reply to another message
-    Args: 
-      message: The text of the message
-      target: The person the message is directed at (as a gwibber compatible object)
+    """Sends a message to Facebook as a reply to another message.
+    
+    Arguments: 
+    message -- The text of the message
+    target -- The person the message is directed at (as a Gwibber compatible object)
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     result = self._get(target["mid"] + "/comments", message=message, post=True)
     if not result:

=== modified file 'gwibber/microblog/plugins/flickr/__init__.py'
--- gwibber/microblog/plugins/flickr/__init__.py	2012-05-23 14:02:10 +0000
+++ gwibber/microblog/plugins/flickr/__init__.py	2012-06-12 20:30:26 +0000
@@ -37,18 +37,24 @@
 IMAGE_PAGE_URL = "http://www.flickr.com/photos/%s/%s"
 
 class Client:
-  """ Client: The Client class is responsible for querying Flickr and turning the data obtained
-  into data that Gwibber can understand.  
+  """Query Flickr, retrieve and convert data.
+  
+  The Client class is responsible for querying Flickr and 
+  turning the data obtained into data that Gwibber can understand.
+   
   """
   def __init__(self, acct):
     self.account = acct
 
   def _message(self, data):
-    """ Parses messages into gwibber compatible forms.
-    Args: 
-      data: A data object obtained from Twitter containing a complete tweet
+    """Parses messages into Gwibber compatible forms.
+    
+    Arguments:
+    data -- A data object obtained from Flickr containing a complete entry
+    
     Returns: 
-      m: A data object compatible with inserting into the Gwibber database for that tweet
+      m -- A data object compatible with inserting into the Gwibber database for that entry
+      
     """
     m = {}
     m["mid"] = str(data["id"])
@@ -80,14 +86,17 @@
     return m
 
   def _get(self, method, parse="message", post=False, **args):
-    """ Establishes a connection with Flickr and gets the data requested.
-    Args: 
-      method: The method to look up on Flickr
-      parse: The function to use to parse the data returned (message by default)
-      post: True is this is a send, False if a recieve (False by default)
-      **args: Args to be added to the url when accessed. 
+    """Establishes a connection with Flickr and gets the data requested.
+    
+    Arguments:
+    method -- The method to look up on Flickr
+    parse -- The function to use to parse the data returned (message by default)
+    post -- True is this is a send, False if a receive (False by default)
+    **args -- Argument to be added to the URL when accessed
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by the parse function
+    A list of Gwibber compatible objects which have been parsed by the parse function.
+      
     """
     args.update({"api_key": API_KEY, "method": method})
     data = network.Download(REST_SERVER, args, post).get_json()
@@ -97,11 +106,14 @@
     else: return data
 
   def _getNSID(self):
-    """ Gets users own Flickr id
-    Args: 
-      None
+    """Gets user's own Flickr ID.
+    
+    Arguments:
+    None
+   
     Returns:
-      A flickr user id
+    The user's Flickr id.
+    
     """
     data = self._get("flickr.people.findByUsername",
         parse=None, nojsoncallback="1", format="json",
@@ -116,11 +128,15 @@
     return getattr(self, opname)(**args)
 
   def images(self):
-    """ Gets a stream of images from Flickr
-    Args: 
-      None
+    """Gets a stream of images from Flickr.
+    
+    Arguments:
+    None
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by the parse function
+    A list of Gwibber compatible objects which have been 
+    parsed by the parse function.
+    
     """
     user_id=self._getNSID()
     if user_id:

=== modified file 'gwibber/microblog/plugins/foursquare/__init__.py'
--- gwibber/microblog/plugins/foursquare/__init__.py	2012-04-10 17:42:04 +0000
+++ gwibber/microblog/plugins/foursquare/__init__.py	2012-06-12 20:30:26 +0000
@@ -34,10 +34,14 @@
 URL_PREFIX = "https://api.foursquare.com/v2"
 
 class Client:
-  """ Client: The Client class is responsible for querying Foursquare and turning the data obtained
-  into data that Gwibber can understand.  Foursquare uses a version of oauth for security.
+  """Query Foursquare and converts data.
+  
+  The Client class is responsible for querying Foursquare and turning the data obtained
+  into data that Gwibber can understand. Foursquare uses a version of OAuth for security.
+  
   Tokens have already been obtained when the account was set up in Gwibber and are used to 
   authenticate when getting data.
+  
   """
   def __init__(self, acct):
     self.service = util.getbus("Service")
@@ -50,11 +54,14 @@
     self.token = acct["access_token"]
 
   def _message(self, data):
-    """ Parses messages into gwibber compatible forms
-    Args: 
-      data: A data object obtained from Foursquare containing a complete checkin
+    """Parses messages into Gwibber compatible forms.
+    
+    Arguments: 
+      data -- A data object obtained from Foursquare containing a complete checkin
+    
     Returns: 
-      m: A data object compatible with inserting into the Gwibber database for that checkin
+      m -- A data object compatible with inserting into the Gwibber database for that checkin
+    
     """
     m = {}; 
     m["mid"] = str(data["id"])
@@ -170,13 +177,17 @@
     return m
 
   def _check_error(self, data):
-    """Checks to ensure the data obtained by Foursquare is on the correct form
-    If not, an error is logged in gwibber.log
-    Args:
-      data: A data structure obtained from Foursquare
+    """Checks to ensure the data obtained by Foursquare is in the correct form.
+    
+    If it's not in the correct form, an error is logged in gwibber.log
+    
+    Arguments:
+    data -- A data structure obtained from Foursquare
+    
     Returns:
-      True if data is valid (is a dict and contains a 'recent' parameter.
-      Otherwise, False
+    True if data is valid (is a dictionary and contains a 'recent' parameter).
+    If the data is not valid, then return False.
+    
     """
     if isinstance(data, dict) and "recent" in data:
       return True
@@ -185,11 +196,14 @@
       return False
   
   def _get_comments(self, checkin_id):
-    """ Gets comments on a particular checkin id.
-    Args: 
-      checkin_id: The checkin id of the checkin
+    """Gets comments on a particular check in ID.
+    
+    Arguments: 
+    checkin_id -- The checkin id of the checkin
+    
     Returns: 
-      A comment object
+    A comment object
+    
     """ 
     url = "/".join((URL_PREFIX, "checkins", checkin_id))
     url = url + "?oauth_token=" + self.token
@@ -197,15 +211,18 @@
     return data["checkin"]["comments"]["items"]
 
   def _get(self, path, parse="message", post=False, single=False, **args):
-    """ Establishes a connection with Foursquare and gets the data requested
-    Args: 
-      path: The end of the url to look up on Foursquare
-      parse: The function to use to parse the data returned (message by default)
-      post: True is this is a send, False if a recieve (False by default)
-      single: True if a single checkin is requested, False if multiple (False by default)
-      **args: Args to be added to the url when accessed. 
+    """Establishes a connection with Foursquare and gets the data requested.
+    
+    Arguments: 
+      path -- The end of the URL to look up on Foursquare
+      parse -- The function to use to parse the data returned (message by default)
+      post -- True if using POST, for example the send operation. False if using GET, most operations other than send. (False by default)
+      single -- True if a single checkin is requested, False if multiple (False by default)
+      **args -- Arguments to be added to the URL when accessed
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by the parse function
+    A list of Gwibber compatible objects which have been parsed by the parse function.
+    
     """
     url = "/".join((URL_PREFIX, path))
     
@@ -245,11 +262,16 @@
     return getattr(self, opname)(**args)
 
   def receive(self):
-    """ Gets a list of each friend's most recent checkins and add them to
-    the database.  
-    Args: 
-      None
+    """Gets a list of each friend's most recent check-ins.
+    
+    The list of each friend's recent check-ins is then
+    saved to the database.
+ 
+    Arguments: 
+    None
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by the parse function
+    A list of Gwibber compatible objects which have been parsed by the parse function.
+    
     """
     return self._get("checkins/recent")

=== modified file 'gwibber/microblog/plugins/identica/__init__.py'
--- gwibber/microblog/plugins/identica/__init__.py	2012-05-23 14:02:10 +0000
+++ gwibber/microblog/plugins/identica/__init__.py	2012-06-12 20:30:26 +0000
@@ -60,10 +60,14 @@
 URL_PREFIX = "https://identi.ca"
 
 class Client:
-  """ Client: The Client class is responsible for querying Identica and turning the data obtained
-  into data that Gwibber can understand.  Identica uses a version of oauth for security.
+  """Query Identica and convert data.
+  
+  The Client class is responsible for querying Identica and turning the data obtained
+  into data that Gwibber can understand. Identica uses a version of OAuth for security.
+  
   Tokens have already been obtained when the account was set up in Gwibber and are used to 
   authenticate when getting data.
+  
   """
   def __init__(self, acct):
     self.url_prefix = "https://identi.ca"
@@ -72,12 +76,17 @@
     self.account = acct
 
   def _common(self, data):
-    """ Parses messages into gwibber compatible forms.  This function is common to all tweet types
-    and includes parsing of user mentions, hashtags, urls, images and videos
-    Args: 
-      data: A data object obtained from Identica containing a complete update
+    """Parses messages into Gwibber compatible forms.  
+    
+    This function is common to all tweet types and includes 
+    parsing of user mentions, hashtags, urls, images and videos.
+    
+    Arguments: 
+    data -- A data object obtained from Identica containing a complete update
+    
     Returns: 
-      m: A data object compatible with inserting into the Gwibber database for that update
+    m -- A data object compatible with inserting into the Gwibber database for that update
+    
     """
     m = {}
     try:
@@ -118,11 +127,14 @@
     return m
 
   def _user(self, user):
-    """ Parses the user portion of an update
-    Args:
-      user: A user object from an update
+    """Parses the user portion of an update.
+    
+    Arguments:
+    user -- A user object from an update
+    
     Returns:
-      A user object in a format compatible with gwibber's database
+    A user object in a format compatible with Gwibber's database.
+    
     """
     return {
         "name": user.get("name", None),
@@ -142,13 +154,19 @@
     }
 
   def _message(self, data):
-    """ Parses messages into gwibber compatible forms.  This is the initial function for 
-    update parsing and parses retweeted status (the shared-by portion)
-    and reply details (the in-reply-to portion). It sends the rest to _common() for further parsing
-    Args: 
-      data: A data object obtained from Identica containing a complete update
+    """Parses messages into Gwibber compatible forms.  
+    
+    This is the initial function for update parsing and parses 
+    retweeted status (the shared-by portion) and reply details 
+    (the in-reply-to portion). It sends the rest to _common() 
+    for further parsing.
+    
+    Arguments: 
+      data -- A data object obtained from Identica containing a complete update
+    
     Returns: 
-      m: A data object compatible with inserting into the Gwibber database for that update
+      m -- A data object compatible with inserting into the Gwibber database for that update
+      
     """
     if type(data) != dict:
       logger.error("Cannot parse message data: %s", str(data))
@@ -186,13 +204,21 @@
     return m
 
   def _private(self, data):
-    """ Sets the message type and privacy if the message should be in the private stream.
-    Also parses the recipient as both sent & recieved messages can be in the private stream.
-    It sends the rest to _message() for further parsing
-    Args: 
-      data: A data object obtained from Identica containing a complete update
+    """Sets the message type and privacy. 
+    
+    Sets the type and privacy of a message if the message
+    should be in the private stream. 
+    
+    Also parses the recipient as both sent & recieved messages
+    can be in the private stream. It sends the rest to _message() 
+    for further parsing.
+    
+    Arguments: 
+    data -- A data object obtained from Identica containing a complete update
+    
     Returns: 
-      m: A data object compatible with inserting into the Gwibber database for that update
+    m -- A data object compatible with inserting into the Gwibber database for that update
+    
     """
     m = self._message(data)
     m["private"] = True
@@ -208,12 +234,17 @@
     return m
 
   def _result(self, data):
-    """ Called when a search is done in gwibber.  Parses the sender and sends the rest to _common()
-    for further parsing
-    Args: 
-      data: A data object obtained from Identica containing a complete update
+    """Called when a search is done in Gwibber.  
+    
+    Parses the sender and sends the rest to _common()
+    for further parsing.
+    
+    Arguments: 
+    data -- A data object obtained from Identica containing a complete update
+    
     Returns: 
-      m: A data object compatible with inserting into the Gwibber database for that update
+    m -- A data object compatible with inserting into the Gwibber database for that update
+    
     """
     m = self._common(data)
     
@@ -231,11 +262,14 @@
     return m
 
   def _profile(self, data):
-    """ Called when a user is clicked on.
-    Args: 
-      data: A data object obtained from Identica containing a complete user
+    """Called when a user is clicked on.
+    
+    Arguments: 
+    data -- A data object obtained from Identica containing a complete user
+    
     Returns: 
-      A data object compatible with inserting into the Gwibber database for that user
+    A data object compatible with inserting into the Gwibber database for that user
+    
     """
     return {
         "name": data.get("name", data["screen_name"]),
@@ -262,15 +296,20 @@
     }
 
   def _get(self, path, parse="message", post=False, single=False, **args):
-    """ Establishes a connection with Identica and gets the data requested.  Requires authentication.
-    Args: 
-      path: The end of the url to look up on Identica
-      parse: The function to use to parse the data returned (message by default)
-      post: True is this is a send, False if a recieve (False by default)
-      single: True if a single checkin is requested, False if multiple (False by default)
-      **args: Args to be added to the url when accessed. 
+    """Establishes a connection with Identica and gets the data requested.  
+    
+    Requires authentication.
+    
+    Arguments: 
+    path -- The end of the url to look up on Identica
+    parse -- The function to use to parse the data returned (message by default)
+    post -- True if using POST, for example the send operation. False if using GET, most operations other than send. (False by default)
+    single -- True if a single checkin is requested, False if multiple (False by default)
+    **args -- Args to be added to the url when accessed. 
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by the parse function
+      A list of Gwibber compatible objects which have been parsed by the parse function.
+      
     """
     if not self.account.has_key("access_token") and not self.account.has_key("secret_token"):
       logger.error("%s unexpected result - %s", PROTOCOL_INFO["name"], _("Account needs to be re-authorized"))
@@ -321,12 +360,16 @@
     return [self._result(m) for m in data]
 
   def _search(self, **args):
-    """ Establishes a connection with Identica and gets the results of a search.
-    Does not require authentication
-    Args: 
-      **args: The search terms
+    """Establishes a connection with Identica and gets the results of a search.
+    
+    Does not require authentication.
+    
+    Arguments: 
+    **args -- The search terms
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _result()
+    A list of Gwibber compatible objects which have been parsed by _result().
+    
     """
     data = network.Download("%s/api/search.json" % self.url_prefix, util.compact(args))
     data = data.get_json()
@@ -341,167 +384,215 @@
     return getattr(self, opname)(**args)
   
   def receive(self, count=util.COUNT, since=None):
-    """ Gets the latest updates and adds them to the database.  
-    Args: 
-      count = number of updates to get
-      since = time to get updates since
+    """Gets the latest updates and adds them to the database.  
+    
+    Arguments: 
+    count -- Number of updates to get
+    since -- Time to get updates since
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _message()
+    A list of Gwibber compatible objects which have been parsed by _message().
+    
     """
     return self._get("statuses/friends_timeline.json", count=count, since_id=since)
 
   def responses(self, count=util.COUNT, since=None):
-    """ Gets the latest replies and adds them to the database.
-    Args: 
-      count = number of updates to get
-      since = time to get updates since
+    """Gets the latest replies and adds them to the database.
+    
+    Arguments: 
+    count -- number of updates to get
+    since -- time to get updates since
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _responses()
+    A list of Gwibber compatible objects which have been parsed by _responses().
+    
     """
     return self._get("statuses/mentions.json", count=count, since_id=since)
 
   def private(self, count=util.COUNT, since=None):
-    """ Gets the latest direct messages sent and recieved and adds them to the database.
+    """Gets the latest direct messages sent and recieved and adds them to the database.
+    
     Args: 
-      count = number of updates to get
-      since = time to get updates since
+    count -- Number of updates to get
+    since -- Time to get updates since
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _private()
+    A list of Gwibber compatible objects which have been parsed by _private().
+    
     """
     private = self._get("direct_messages.json", "private", count=count, since_id=since) or []
     private_sent = self._get("direct_messages/sent.json", "private", count=count, since_id=since) or []
     return private + private_sent
 
   def public(self, count=util.COUNT, since=None):
-    """ Gets the latest updates from the public timeline and adds them to the database.
-    Args: 
-      count = number of updates to get
-      since = time to get updates since
+    """Gets the latest updates from the public timeline and adds them to the database.
+    
+    Arguments: 
+    count -- Number of updates to get
+    since -- Time to get updates since
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _message()
+    A list of Gwibber compatible objects which have been parsed by _message().
+    
     """
     return self._get("statuses/public_timeline.json")
 
   def search(self, query, count=util.COUNT, since=None):
-    """ Gets the latest results from a search and adds them to the database.
-    Args: 
-      query = the search query
-      count = number of updates to get
-      since = time to get updates since
+    """Gets the latest results from a search and adds them to the database.
+    
+    Arguments: 
+    query -- The search query
+    count -- Number of updates to get
+    since -- Time to get updates since
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _search()
+    A list of Gwibber compatible objects which have been parsed by _search().
+    
     """
     return self._search(q=query, rpp=count, since_id=since)
 
   def tag(self, query, count=util.COUNT, since=None):
-    """ Gets the latest results from a hashtag search and adds them to the database.
-    Args: 
-      query = the search query (hashtag without the #)
-      count = number of updates to get
-      since = time to get updates since
+    """Gets the latest results from a hashtag search and adds them to the database.
+    
+    Arguments: 
+    query -- The search query (hashtag without the #)
+    count -- Number of updates to get
+    since -- Time to get updates since
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _search()
+    A list of Gwibber compatible objects which have been parsed by _search().
+    
     """
     return self._search(q="#%s" % query, count=count, since_id=since)
 
   def delete(self, message):
-    """ Deletes a specified tweet from Identica
-    Args: 
-      message: a gwibber compatible message object (from gwibber's database)
+    """Deletes a specified tweet from Identica.
+    
+    Arguments: 
+    message -- A Gwibber compatible message object (from gwibber's database)
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     self._get("statuses/destroy/%s.json" % message["mid"], None, post=True, do=1)
     return []
 
   def like(self, message):
-    """ Favourites a specified tweet on Identica
-    Args: 
-      message: a gwibber compatible message object (from gwibber's database)
+    """Favourites a specified tweet on Identica.
+    
+    Arguments: 
+    message -- A Gwibber compatible message object (from Gwibber's database)
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     self._get("favorites/create/%s.json" % message["mid"], None, post=True, do=1)
     return []
 
   def send(self, message):
-    """ Sends an update to Identica
-    Args: 
-      message: The update's text
+    """Sends an update to Identica.
+    
+    Arguments: 
+    message -- The update's text
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     return self._get("statuses/update.json", post=True, single=True,
         status=message, source="Gwibber")
 
   def send_private(self, message, private):
-    """ Sends a direct message to Identica
-    Args: 
-      message: The update's text
-      private: A gwibber compatible user object (from gwibber's database)
+    """Sends a direct message to Identica.
+    
+    Arguments: 
+    message -- The update's text
+    private -- A Gwibber compatible user object (from Gwibber's database)
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     return self._get("direct_messages/new.json", "private", post=True, single=True,
         text=message, screen_name=private["sender"]["nick"])
 
   def send_thread(self, message, target):
-    """ Sends a reply to a user on Identica
-    Args: 
-      message: The update's text
-      target: A gwibber compatible user object (from gwibber's database)
+    """Sends a reply to a user on Identica.
+    
+    Arguments: 
+    message -- The update's text
+    target -- A Gwibber compatible user object (from Gwibber's database)
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     return self._get("statuses/update.json", post=True, single=True,
         status=message, source="Gwibber", in_reply_to_status_id=target["mid"])
 
   def retweet(self, message):
-    """ Shares an update
-    Args: 
-      message: A gwibber compatible message object (from gwibber's database)
+    """Shares an update.
+    
+    Arguments: 
+    message -- A Gwibber compatible message object (from Gwibber's database)
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     return self._get("statuses/retweet/%s.json" % message["mid"], None, post=True, do=1, source="Gwibber")
 
   def follow(self, screen_name):
-    """ Follows a user
-    Args: 
-      screen_name: The screen name of the user to be followed
+    """Follows a user.
+    
+    Arguments: 
+    screen_name -- The screen name of the user to be followed
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     return self._get("friendships/create.json", screen_name=screen_name, post=True, parse="follow", source="Gwibber")
 
   def unfollow(self, screen_name):
-    """ Unfollows a user
-    Args: 
-      screen_name: The screen name of the user to be unfollowed
+    """Unfollows a user.
+    
+    Arguments: 
+    screen_name -- The screen name of the user to be unfollowed
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     return self._get("friendships/destroy.json", screen_name=screen_name, post=True, parse="unfollow", source="Gwibber")
 
   def profile(self, id=None, count=None, since=None):
-    """ Gets a user's profile
-    Args: 
-      id: The user's screen name
-      count: Number of updates to get
-      since: Time to get updates since
+    """Gets a user's profile.
+    
+    Arguments: 
+    id -- The user's screen name
+    count -- Number of updates to get
+    since -- Time to get updates since
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _profile()
+    A list of Gwibber compatible objects which have been parsed by _profile().
+    
     """
     return self._get("users/show.json", screen_name=id, count=count, since_id=since, parse="profile", source="Gwibber")
 
   def user_messages(self, id=None, count=util.COUNT, since=None):
-    """ Gets a user's profile & timeline
+    """Gets a user's profile & timeline.
+    
     Args: 
-      id: The user's screen name
-      count: Number of updates to get
-      since: Time to get updates since
+    id -- The user's screen name
+    count -- Number of updates to get
+    since -- Time to get updates since
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _profile()
+    A list of Gwibber compatible objects which have been parsed by _profile().
+    
     """
     profiles = [self.profile(id)] or []
     messages = self._get("statuses/user_timeline.json", id=id, count=count, since_id=since, source="Gwibber") or []

=== modified file 'gwibber/microblog/plugins/statusnet/__init__.py'
--- gwibber/microblog/plugins/statusnet/__init__.py	2012-05-23 14:02:10 +0000
+++ gwibber/microblog/plugins/statusnet/__init__.py	2012-06-12 20:30:26 +0000
@@ -12,7 +12,7 @@
 PROTOCOL_INFO = {
   "name": "StatusNet",
   "version": 1.1,
-  
+
   "config": [
     "private:secret_token",
     "access_token",
@@ -56,10 +56,14 @@
 }
 
 class Client:
-  """ Client: The Client class is responsible for querying the StatusNet server and turning the data obtained
-  into data that Gwibber can understand.  The StatusNet server uses a version of oauth for security.
-  Tokens have already been obtained when the account was set up in Gwibber and are used to 
+  """Query the StatusNet server and convert the data.
+
+  The Client class is responsible for querying the StatusNet server and turning the data obtained
+  into data that Gwibber can understand. The StatusNet server uses a version of OAuth for security.
+  
+  Tokens have already been obtained when the account was set up in Gwibber and are used to
   authenticate when getting data.
+
   """
   def __init__(self, acct):
     if acct.has_key("url_prefix"):
@@ -71,12 +75,18 @@
     self.account = acct
 
   def _common(self, data):
-    """ Parses messages into gwibber compatible forms.  This function is common to all update types
-    and includes parsing of user mentions, hashtags, urls, images and videos
-    Args: 
-      data: A data object obtained from the StatusNet server containing a complete update
-    Returns: 
-      m: A data object compatible with inserting into the Gwibber database for that update
+    """Parses messages into Gwibber compatible forms.
+
+    This function is common to all update types
+    and includes parsing of user mentions, hashtags,
+    urls, images and videos.
+
+    Arguments:
+    data -- A data object obtained from the StatusNet server containing a complete update
+
+    Returns:
+    m -- A data object compatible with inserting into the Gwibber database for that update
+
     """
     m = {}
     try:
@@ -107,7 +117,7 @@
             images.append({"src": a["url"], "url": a["url"]})
 
       images.extend(util.imgpreview(m["text"]))
-  
+
       if images:
         m["images"] = images
         m["type"] = "photo"
@@ -117,11 +127,14 @@
     return m
 
   def _user(self, user):
-    """ Parses the user portion of an update
-    Args:
-      user: A user object from an update
+    """Parses the user portion of an update.
+
+    Arguments:
+    user -- A user object from an update
+
     Returns:
-      A user object in a format compatible with gwibber's database
+    A user object in a format compatible with Gwibber's database
+
     """
     return {
         "name": user.get("name", None),
@@ -141,13 +154,19 @@
     }
 
   def _message(self, data):
-    """ Parses messages into gwibber compatible forms.  This is the initial function for 
-    tweet parsing and parses shared status, source (the program the update was sent from)
-    and reply details (the in-reply-to portion). It sends the rest to _common() for further parsing
-    Args: 
-      data: A data object obtained from the StatusNet server containing a complete update
-    Returns: 
-      m: A data object compatible with inserting into the Gwibber database for that tweet
+    """Parses messages into Gwibber compatible forms.
+
+    This is the initial function for tweet parsing and parses
+    shared status, source (the program the update was sent from)
+    and reply details (the in-reply-to portion). It sends the rest
+    to _common() for further parsing.
+
+    Arguments:
+    data -- A data object obtained from the StatusNet server containing a complete update
+
+    Returns:
+    m -- A data object compatible with inserting into the Gwibber database for that tweet
+
     """
     if type(data) != dict:
       logger.error("Cannot parse message data: %s", str(data))
@@ -167,7 +186,7 @@
     m = self._common(data)
     for k in n:
       m[k] = n[k]
-    
+
     if data.has_key("in_reply_to_status_id"):
       if data["in_reply_to_status_id"]:
         m["reply"] = {}
@@ -184,13 +203,21 @@
     return m
 
   def _private(self, data):
-    """ Sets the message type and privacy if the message should be in the private stream.
-    Also parses the recipient as both sent & recieved messages can be in the private stream.
+    """Sets the message type and privacy.
+
+    Sets the message type and privacy if the
+    message should be in the private stream.
+
+    Also parses the recipient as both sent &
+    received messages can be in the private stream.
     It sends the rest to _message() for further parsing
-    Args: 
-      data: A data object obtained from the StatusNet server containing a complete update
-    Returns: 
-      m: A data object compatible with inserting into the Gwibber database for that update
+
+    Arguments:
+    data -- A data object obtained from the StatusNet server containing a complete update
+
+    Returns:
+    m -- A data object compatible with inserting into the Gwibber database for that update
+
     """
     m = self._message(data)
     m["private"] = True
@@ -206,15 +233,20 @@
     return m
 
   def _result(self, data):
-    """ Called when a search is done in gwibber.  Parses the sender and sends the rest to _common()
-    for further parsing
-    Args: 
-      data: A data object obtained from the StatusNet server containing a complete update
-    Returns: 
-      m: A data object compatible with inserting into the Gwibber database for that update
+    """Called when a search is done in Gwibber.
+
+    Parses the sender and sends the rest to _common()
+    for further parsing.
+
+    Args:
+    data -- A data object obtained from the StatusNet server containing a complete update
+
+    Returns:
+    m -- A data object compatible with inserting into the Gwibber database for that update
+
     """
     m = self._common(data)
-    
+
     if data["to_user_id"]:
       m["reply"] = {}
       m["reply"]["id"] = data["to_user_id"]
@@ -229,11 +261,14 @@
     return m
 
   def _profile(self, data):
-    """ Called when a user is clicked on.
-    Args: 
-      data: A data object obtained from the StatusNet server containing a complete user
-    Returns: 
-      A data object compatible with inserting into the Gwibber database for that user
+    """Called when a user is clicked on.
+
+    Arguments:
+    data -- A data object obtained from the StatusNet server containing a complete user
+
+    Returns:
+    A data object compatible with inserting into the Gwibber database for that user.
+
     """
     return {
         "name": data.get("name", data["screen_name"]),
@@ -260,15 +295,20 @@
     }
 
   def _get(self, path, parse="message", post=False, single=False, **args):
-    """ Establishes a connection with the StatusNet server and gets the data requested.  Requires authentication.
-    Args: 
-      path: The end of the url to look up on the StatusNet server
-      parse: The function to use to parse the data returned (message by default)
-      post: True is this is a send, False if a recieve (False by default)
-      single: True if a single checkin is requested, False if multiple (False by default)
-      **args: Args to be added to the url when accessed. 
+    """Establishes a connection with the StatusNet server and gets the data requested.
+
+    Requires authentication.
+
+    Arguments:
+    path -- The end of the URL to look up on the StatusNet server
+    parse -- The function to use to parse the data returned (message by default)
+    post -- True if using POST, for example the send operation. False if using GET, most operations other than send. (False by default)
+    single -- True if a single checkin is requested, False if multiple (False by default)
+    **args -- Arguments to be added to the URL when accessed
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by the parse function
+    A list of Gwibber compatible objects which have been parsed by the parse function.
+    
     """
     if not self.account.has_key("access_token") and not self.account.has_key("secret_token"):
       logger.error("%s unexpected result - %s", PROTOCOL_INFO["name"], _("Account needs to be re-authorized"))
@@ -320,12 +360,16 @@
     return [self._result(m) for m in data]
 
   def _search(self, **args):
-    """ Establishes a connection with the StatusNet server and gets the results of a search.
+    """Establishes a connection with the StatusNet server and gets the results of a search.
+    
     Does not require authentication
-    Args: 
-      **args: 
+    
+    Arguments:
+    **args -- Example, if _search(tag=bar,name=foo) then **args is tag, name
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _result()
+    A list of Gwibber compatible objects which have been parsed by _result().
+    
     """
     data = network.Download("%s/api/search.json" % self.account["url_prefix"], util.compact(args))
     data = data.get_json()
@@ -338,160 +382,207 @@
 
   def __call__(self, opname, **args):
     return getattr(self, opname)(**args)
-  
+
   def receive(self, count=util.COUNT, since=None):
-    """ Gets the latest updates and adds them to the database.  
-    Args: 
-      None
+    """Gets the latest updates and adds them to the database.
+    
+    Arguments:
+    None
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _message()
+    A list of Gwibber compatible objects which have been parsed by _message().
+    
     """
     return self._get("statuses/friends_timeline.json", count=count, since_id=since, source="Gwibber")
 
   def responses(self, count=util.COUNT, since=None):
-    """ Gets the latest replies and adds them to the database.
-    Args: 
-      None
+    """Gets the latest replies and adds them to the database.
+    
+    Arguments:
+    None
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _responses()
+    A list of Gwibber compatible objects which have been parsed by _responses().
+    
     """
     return self._get("statuses/mentions.json", count=count, since_id=since, source="Gwibber")
 
   def private(self, count=util.COUNT, since=None):
-    """ Gets the latest direct messages sent and recieved and adds them to the database.
-    Args: 
-      None
+    """Gets the latest direct messages sent and received and adds them to the database.
+    
+    Arguments:
+    None
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _private()
+    A list of Gwibber compatible objects which have been parsed by _private().
+    
     """
     private = self._get("direct_messages.json", "private", count=count, since_id=since, source="Gwibber") or []
     private_sent = self._get("direct_messages/sent.json", "private", count=count, since_id=since, source="Gwibber") or []
     return private + private_sent
 
   def public(self, count=util.COUNT, since=None):
-    """ Gets the latest updates from the public timeline and adds them to the database.
-    Args: 
-      None
+    """Gets the latest updates from the public timeline and adds them to the database.
+    
+    Arguments:
+    None
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _message()
+    A list of Gwibber compatible objects which have been parsed by _message().
+    
     """
     return self._get("statuses/public_timeline.json", source="Gwibber")
 
   def search(self, query, count=util.COUNT, since=None):
-    """ Gets the latest results from a search and adds them to the database.
-    Args: 
-      None
+    """Gets the latest results from a search and adds them to the database.
+    
+    Arguments:
+    None
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _search()
+    A list of Gwibber compatible objects which have been parsed by _search().
+    
     """
     return self._search(q=query, rpp=count, since_id=since, source="Gwibber")
 
   def tag(self, query, count=util.COUNT, since=None):
-    """ Gets the latest results from a hashtag search and adds them to the database.
-    Args: 
-      None
+    """Gets the latest results from a hashtag search and adds them to the database.
+    
+    Arguments:
+    None
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _search()
+    A list of Gwibber compatible objects which have been parsed by _search()
+    
     """
     return self._search(q="#%s" % query, count=count, since_id=since, source="Gwibber")
 
   def delete(self, message):
-    """ Deletes a specified update from the StatusNet server
-    Args: 
-      message: a gwibber compatible message object (from gwibber's database)
+    """Deletes a specified update from the StatusNet server.
+    
+    Arguments:
+    message -- A Gwibber compatible message object (from Gwibber's database)
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     self._get("statuses/destroy/%s.json" % message["mid"], None, post=True, do=1, source="Gwibber")
     return []
 
   def like(self, message):
-    """ Favourites a specified update on the StatusNet server
-    Args: 
-      message: a gwibber compatible message object (from gwibber's database)
+    """Favorites a specified update on the StatusNet server.
+    
+    Arguments:
+    message -- A Gwibber compatible message object (from Gwibber's database)
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     self._get("favorites/create/%s.json" % message["mid"], None, post=True, do=1, source="Gwibber")
     return []
 
   def send(self, message):
-    """ Sends a message to the StatusNet server
-    Args: 
-      message: The update's text
+    """Sends a message to the StatusNet server.
+    
+    Arguments:
+    message -- The update's text
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     return self._get("statuses/update.json", post=True, single=True, status=message, source="Gwibber")
 
   def send_private(self, message, private):
-    """ Sends a direct message to the StatusNet server
-    Args: 
-      message: The update's text
-      private: A gwibber compatible user object (from gwibber's database)
+    """Sends a direct message to the StatusNet server.
+    
+    Arguments:
+    message -- The update's text
+    private -- A Gwibber compatible user object (from Gwibber's database)
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     return self._get("direct_messages/new.json", "private", post=True, single=True,
         text=message, screen_name=private["sender"]["nick"], source="Gwibber")
 
   def send_thread(self, message, target):
-    """ Sends a reply to a user on the StatusNet server
-    Args: 
-      message: The update's text
-      target: A gwibber compatible user object (from gwibber's database)
+    """Sends a reply to a user on the StatusNet server.
+    
+    Arguments:
+    message -- The update's text
+    target -- A Gwibber compatible user object (from Gwibber's database)
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     return self._get("statuses/update.json", post=True, single=True,
         status=message, in_reply_to_status_id=target["mid"], source="Gwibber")
 
   def retweet(self, message):
-    """ Shares an update
-    Args: 
-      message: A gwibber compatible message object (from gwibber's database)
+    """Shares an update.
+    Arguments:
+    message -- A Gwibber compatible message object (from Gwibber's database)
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     return self._get("statuses/retweet/%s.json" % message["mid"], None, post=True, do=1, source="Gwibber")
 
   def follow(self, screen_name):
-    """ Follows a user
-    Args: 
-      screen_name: The screen name of the user to be followed
+    """Follows a user.
+    
+    Arguments:
+    screen_name -- The screen name of the user to be followed
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     return self._get("friendships/create.json", screen_name=screen_name, post=True, parse="follow", source="Gwibber")
 
   def unfollow(self, screen_name):
-    """ Unfollows a user
-    Args: 
-      screen_name: The screen name of the user to be unfollowed
+    """Unfollows a user.
+    
+    Arguments:
+    screen_name -- The screen name of the user to be unfollowed
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     return self._get("friendships/destroy.json", screen_name=screen_name, post=True, parse="unfollow", source="Gwibber")
 
   def profile(self, id=None, count=None, since=None):
-    """ Gets a user's profile
-    Args: 
-      id: The user's screen name
-      count: Number of updates to get
-      since: Time to get updates since
+    """Gets a user's profile.
+    
+    Arguments:
+    id -- The user's screen name
+    count -- Number of updates to get
+    since -- Time to get updates since
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _profile()
+    A list of Gwibber compatible objects which have been parsed by _profile().
+    
     """
     return self._get("users/show.json", screen_name=id, count=count, since_id=since, parse="profile", source="Gwibber")
 
   def user_messages(self, id=None, count=util.COUNT, since=None):
-    """ Gets a user's profile & timeline
-    Args: 
-      id: The user's screen name
-      count: Number of updates to get
-      since: Time to get updates since
+    """Gets a user's profile & timeline.
+    
+    Arguments:
+    id -- The user's screen name
+    count -- Number of updates to get
+    since -- Time to get updates since
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _profile()
+    A list of Gwibber compatible objects which have been parsed by _profile().
+    
     """
     profiles = [self.profile(id)] or []
     messages = self._get("statuses/user_timeline.json", id=id, count=count, since_id=since, source="Gwibber") or []

=== modified file 'gwibber/microblog/plugins/twitter/__init__.py'
--- gwibber/microblog/plugins/twitter/__init__.py	2012-05-23 14:02:10 +0000
+++ gwibber/microblog/plugins/twitter/__init__.py	2012-06-12 20:30:26 +0000
@@ -62,10 +62,14 @@
 API_PREFIX = "https://api.twitter.com/1"
 
 class Client ():
-  """ Client: The Client class is responsible for querying Twitter and turning the data obtained
-  into data that Gwibber can understand.  Twitter uses a version of oauth for security.
+  """Querys Twitter and converts the data.
+  
+  The Client class is responsible for querying Twitter and turning the data obtained
+  into data that Gwibber can understand. Twitter uses a version of OAuth for security.
+  
   Tokens have already been obtained when the account was set up in Gwibber and are used to 
   authenticate when getting data.
+  
   """
   def __init__(self, acct):
     self.service = util.getbus("Service")
@@ -80,12 +84,18 @@
     self.token = oauth.OAuthToken(acct["access_token"], acct["secret_token"])
 
   def _common(self, data):
-    """ Parses messages into gwibber compatible forms.  This function is common to all tweet types
-    and includes parsing of user mentions, hashtags, urls, images and videos
-    Args: 
-      data: A data object obtained from Twitter containing a complete tweet
+    """Parses messages into Gwibber compatible forms.  
+    
+    This function is common to all tweet types
+    and includes parsing of user mentions, hashtags, 
+    urls, images and videos.
+    
+    Arguments: 
+    data -- A data object obtained from Twitter containing a complete tweet
+    
     Returns: 
-      m: A data object compatible with inserting into the Gwibber database for that tweet
+    m -- A data object compatible with inserting into the Gwibber database for that tweet
+    
     """
     m = {}
     try:
@@ -215,11 +225,14 @@
     return m
 
   def _user(self, user):
-    """ Parses the user portion of a tweet
-    Args:
-      user: A user object from a tweet
+    """Parses the user portion of a tweet.
+    
+    Arguments:
+    user -- A user object from a tweet
+    
     Returns:
-      A user object in a format compatible with gwibber's database
+    A user object in a format compatible with Gwibber's database.
+    
     """
     return {
         "name": user.get("name", None),
@@ -239,13 +252,19 @@
     }
     
   def _message(self, data):
-    """ Parses messages into gwibber compatible forms.  This is the initial function for 
-    tweet parsing and parses retweeted status (the shared-by portion), source (the program the tweet was tweeted from)
-    and reply details (the in-reply-to portion). It sends the rest to _common() for further parsing
-    Args: 
-      data: A data object obtained from Twitter containing a complete tweet
+    """Parses messages into gwibber compatible forms.
+    
+    This is the initial function for tweet parsing and parses 
+    retweeted status (the shared-by portion), source (the program 
+    the tweet was tweeted from) and reply details (the in-reply-to 
+    portion). It sends the rest to _common() for further parsing.
+    
+    Arguments: 
+    data -- A data object obtained from Twitter containing a complete tweet
+    
     Returns: 
-      m: A data object compatible with inserting into the Gwibber database for that tweet
+    m -- A data object compatible with inserting into the Gwibber database for that tweet
+    
     """
     if type(data) != dict:
       logger.error("Cannot parse message data: %s", str(data))
@@ -284,12 +303,16 @@
     return m
 
   def _responses(self, data):
-    """ Sets the message type if the message should be in the replies stream. 
-    It sends the rest to _message() for further parsing
-    Args: 
-      data: A data object obtained from Twitter containing a complete tweet
+    """Sets the message type if the message should be in the replies stream. 
+    
+    It sends the rest to _message() for further parsing.
+    
+    Arguments: 
+    data -- A data object obtained from Twitter containing a complete tweet
+    
     Returns: 
-      m: A data object compatible with inserting into the Gwibber database for that tweet
+    m -- A data object compatible with inserting into the Gwibber database for that tweet
+    
     """
     m = self._message(data)
     m["type"] = None
@@ -297,13 +320,18 @@
     return m
 
   def _private(self, data):
-    """ Sets the message type and privacy if the message should be in the private stream.
+    """Sets the message type and privacy.
+    
+    Sets the message type and privacy if the message should be in the private stream.
     Also parses the recipient as both sent & recieved messages can be in the private stream.
     It sends the rest to _message() for further parsing
-    Args: 
-      data: A data object obtained from Twitter containing a complete tweet
+    
+    Arguments: 
+    data -- A data object obtained from Twitter containing a complete tweet
+    
     Returns: 
-      m: A data object compatible with inserting into the Gwibber database for that tweet
+    m -- A data object compatible with inserting into the Gwibber database for that tweet
+    
     """
     m = self._message(data)
     m["private"] = True
@@ -322,12 +350,17 @@
     return m
 
   def _result(self, data):
-    """ Called when a search is done in gwibber.  Parses the sender and sends the rest to _common()
-    for further parsing
-    Args: 
-      data: A data object obtained from Twitter containing a complete tweet
+    """Called when a search is done in Gwibber.  
+    
+    Parses the sender and sends the rest to _common()
+    for further parsing.
+    
+    Arguments: 
+    data -- A data object obtained from Twitter containing a complete tweet
+    
     Returns: 
-      m: A data object compatible with inserting into the Gwibber database for that tweet
+    m -- A data object compatible with inserting into the Gwibber database for that tweet
+    
     """
     m = self._common(data)
     
@@ -346,11 +379,14 @@
     return m
 
   def _profile(self, data):
-    """ Called when a user is clicked on.
+    """Called when a user is clicked on.
+    
     Args: 
-      data: A data object obtained from Twitter containing a complete user
+    data -- A data object obtained from Twitter containing a complete user
+    
     Returns: 
-      A data object compatible with inserting into the Gwibber database for that user
+    A data object compatible with inserting into the Gwibber database for that user.
+    
     """
     if "error" in data:
       return {
@@ -381,11 +417,14 @@
     }
 
   def _list(self, data):    
-    """ Called when a list is clicked on.
+    """Called when a list is clicked on.
+    
     Args: 
-      data: A data object obtained from Twitter containing a complete list
+    data -- A data object obtained from Twitter containing a complete list
+    
     Returns: 
-      A data object compatible with inserting into the Gwibber database for that list
+    A data object compatible with inserting into the Gwibber database for that list.
+    
     """
     return {
         "mid": data["id"],
@@ -409,15 +448,20 @@
     }
 
   def _get(self, path, parse="message", post=False, single=False, **args):
-    """ Establishes a connection with Twitter and gets the data requested.  Requires authentication.
-    Args: 
-      path: The end of the url to look up on Twitter
-      parse: The function to use to parse the data returned (message by default)
-      post: True is this is a send, False if a recieve (False by default)
-      single: True if a single checkin is requested, False if multiple (False by default)
-      **args: Args to be added to the url when accessed. 
+    """Establishes a connection with Twitter and gets the data requested.  
+    
+    Requires authentication.
+    
+    Arguments: 
+    path -- The end of the url to look up on Twitter
+    parse -- The function to use to parse the data returned (message by default)
+    post -- True if using POST, for example the send operation. False if using GET, most operations other than send. (False by default)
+    single -- True if a single checkin is requested, False if multiple (False by default)
+    **args -- Arguments to be added to the URL when accessed. 
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by the parse function
+    A list of Gwibber compatible objects which have been parsed by the parse function.
+    
     """
     url = "/".join((API_PREFIX, path))
 
@@ -470,12 +514,16 @@
     else: return []
 
   def _search(self, **args):
-    """ Establishes a connection with Twitter and gets the results of a search.
+    """Establishes a connection with Twitter and gets the results of a search.
+    
     Does not require authentication
-    Args: 
-      **args: The search terms
+    
+    Arguments: 
+    **args -- The search terms
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _result()
+    A list of Gwibber compatible objects which have been parsed by _result().
+    
     """
     data = network.Download("http://search.twitter.com/search.json", util.compact(args))
     data = data.get_json()["results"]
@@ -490,187 +538,241 @@
     return getattr(self, opname)(**args)
   
   def receive(self, count=util.COUNT, since=None):
-    """ Gets the latest tweets and adds them to the database.  
-    Args: 
-      count = number of updates to get
-      since = time to get updates since
+    """Gets the latest tweets and adds them to the database.  
+    
+    Arguments: 
+    count -- Number of updates to get
+    since -- Time to get updates since
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _message()
+    A list of Gwibber compatible objects which have been parsed by _message().
+    
     """
     return self._get("statuses/home_timeline.json", include_entities=1, count=count, since_id=since)
 
   def responses(self, count=util.COUNT, since=None):
-    """ Gets the latest replies and adds them to the database.
-    Args: 
-      count = number of updates to get
-      since = time to get updates since
+    """Gets the latest replies and adds them to the database.
+    
+    Arguments: 
+    count  -- Number of updates to get
+    since  -- Time to get updates since
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _responses()
+    A list of Gwibber compatible objects which have been parsed by _responses().
+    
     """
     return self._get("statuses/mentions.json", "responses", include_entities=1, count=count, since_id=since)
 
   def private(self, count=util.COUNT, since=None):
-    """ Gets the latest direct messages sent and recieved and adds them to the database.
+    """Gets the latest direct messages sent and recieved and adds them to the database.
+    
     Args: 
-      count = number of updates to get
-      since = time to get updates since
+    count -- Number of updates to get
+    since -- Time to get updates since
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _private()
+    A list of Gwibber compatible objects which have been parsed by _private().
+    
     """
     private = self._get("direct_messages.json", "private", include_entities=1, count=count, since_id=since) or []
     private_sent = self._get("direct_messages/sent.json", "private", count=count, since_id=since) or []
     return private + private_sent
 
   def public(self):
-    """ Gets the latest tweets from the public timeline and adds them to the database.
-    Args: 
-      None
+    """Gets the latest tweets from the public timeline and adds them to the database.
+    
+    Arguments: 
+    None
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _message()
+    A list of Gwibber compatible objects which have been parsed by _message().
+    
     """
     return self._get("statuses/public_timeline.json", include_entities=1)
 
   def lists(self, **args):
-    """ Gets subscribed lists and adds them to the database.
-    Args: 
-      None
+    """Gets subscribed lists and adds them to the database.
+    
+    Arguments: 
+    None
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _list()
+    A list of Gwibber compatible objects which have been parsed by _list().
+    
     """
     following = self._get("%s/lists/subscriptions.json" % self.account["username"], "list") or []
     lists = self._get("%s/lists.json" % self.account["username"], "list") or []
     return following + lists
 
   def list(self, user, id, count=util.COUNT, since=None):    
-    """ Gets the latest tweets from subscribed lists and adds them to the database.
-    Args: 
-      user = the user's name whose lists are to be got
-      id = the user's id whose lists are to be got
-      count = number of updates to get
-      since = time to get updates since
+    """Gets the latest tweets from subscribed lists and adds them to the database.
+    
+    Arguments: 
+    user -- The user's name whose lists are to be got
+    id -- The user's id whose lists are to be got
+    count -- Number of updates to get
+    since -- Time to get updates since
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _message()
+    A list of Gwibber compatible objects which have been parsed by _message().
+    
     """
     return self._get("%s/lists/%s/statuses.json" % (user, id), include_entities=1, per_page=count, since_id=since)
 
   def search(self, query, count=util.COUNT, since=None):
-    """ Gets the latest results from a search and adds them to the database.
-    Args: 
-      query = the search query
-      count = number of updates to get
-      since = time to get updates since
+    """Gets the latest results from a search and adds them to the database.
+    
+    Arguments: 
+    query -- The search query
+    count -- Number of updates to get
+    since -- Time to get updates since
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _search()
+    A list of Gwibber compatible objects which have been parsed by _search().
+    
     """
     return self._search(include_entities=1, q=query, rpp=count, since_id=since)
 
   def tag(self, query, count=util.COUNT, since=None):
-    """ Gets the latest results from a hashtag search and adds them to the database.
-    Args: 
-      query = the search query (hashtag without the #)
-      count = number of updates to get
-      since = time to get updates since
+    """Gets the latest results from a hashtag search and adds them to the database.
+    
+    Arguments: 
+    query -- The search query (hashtag without the #)
+    count -- Number of updates to get
+    since -- Time to get updates since
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _search()
+    A list of Gwibber compatible objects which have been parsed by _search().
+    
     """
     return self._search(q="#%s" % query, count=count, since_id=since)
 
   def delete(self, message):
-    """ Deletes a specified tweet from twitter
-    Args: 
-      message: a gwibber compatible message object (from gwibber's database)
+    """Deletes a specified tweet from Twitter.
+    
+    Arguments: 
+    message -- A Gwibber compatible message object (from gwibber's database)
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     return self._get("statuses/destroy/%s.json" % message["mid"], None, post=True, do=1)
 
   def like(self, message):
-    """ Favourites a specified tweet on twitter
-    Args: 
-      message: a gwibber compatible message object (from gwibber's database)
+    """Favourites a specified tweet on Twitter.
+    
+    Arguments: 
+    message -- A Gwibber compatible message object (from Gwibber's database)
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     return self._get("favorites/create/%s.json" % message["mid"], None, post=True, do=1)
 
   def send(self, message):
-    """ Sends a tweet to twitter
-    Args: 
-      message: The tweet's text
+    """Sends a tweet to Twitter.
+    
+    Arguments: 
+    message -- The tweet's text
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     return self._get("statuses/update.json", post=True, single=True,
         status=message)
   
   def send_private(self, message, private):
-    """ Sends a direct message to twitter
-    Args: 
-      message: The tweet's text
-      private: A gwibber compatible user object (from gwibber's database)
+    """Sends a direct message to Twitter.
+    
+    Arguments: 
+    message -- The tweet's text
+    private -- A gwibber compatible user object (from gwibber's database)
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     return self._get("direct_messages/new.json", "private", post=True, single=True,
         text=message, screen_name=private["sender"]["nick"])
 
   def send_thread(self, message, target):
-    """ Sends a reply to a user on twitter
-    Args: 
-      message: The tweet's text
-      target: A gwibber compatible user object (from gwibber's database)
+    """Sends a reply to a user on Twitter.
+    
+    Arguments: 
+    message -- The tweet's text
+    target -- A Gwibber compatible user object (from Gwibber's database)
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     return self._get("statuses/update.json", post=True, single=True,
         status=message, in_reply_to_status_id=target["mid"])
 
   def retweet(self, message):
-    """ Retweets a tweet
-    Args: 
-      message: A gwibber compatible message object (from gwibber's database)
+    """Retweets a tweet.
+    
+    Arguments: 
+    message -- A Gwibber compatible message object (from gwibber's database)
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     return self._get("statuses/retweet/%s.json" % message["mid"], None, post=True, do=1)
 
   def follow(self, screen_name):
-    """ Follows a user
-    Args: 
-      screen_name: The screen name (@someone without the @) of the user to be followed
+    """Follows a user.
+    
+    Arguments: 
+    screen_name -- The screen name (@someone without the @) of the user to be followed
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     return self._get("friendships/create.json", screen_name=screen_name, post=True, parse="follow")
 
   def unfollow(self, screen_name):
-    """ Unfollows a user
-    Args: 
-      screen_name: The screen name (@someone without the @) of the user to be unfollowed
+    """Unfollows a user.
+    
+    Arguments: 
+    screen_name -- The screen name (@someone without the @) of the user to be unfollowed
+    
     Returns:
-      Nothing
+    Nothing
+    
     """
     return self._get("friendships/destroy.json", screen_name=screen_name, post=True, parse="unfollow")
 
   def profile(self, id=None, count=None, since=None):
-    """ Gets a user's profile
-    Args: 
-      id: The user's screen name
-      count: Number of tweets to get
-      since: Time to get tweets since
+    """Gets a user's profile.
+    
+    Arguments: 
+    id -- The user's screen name
+    count -- Number of tweets to get
+    since -- Time to get tweets since
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _profile()
+    A list of Gwibber compatible objects which have been parsed by _profile().
+    
     """
     return self._get("users/show.json", screen_name=id, count=count, since_id=since, parse="profile")
 
   def user_messages(self, id=None, count=util.COUNT, since=None):
-    """ Gets a user's profile & timeline
-    Args: 
-      id: The user's screen name
-      count: Number of tweets to get
-      since: Time to get tweets since
+    """Gets a user's profile & timeline.
+    
+    Arguments: 
+    id -- The user's screen name
+    count -- Number of tweets to get
+    since -- Time to get tweets since
+    
     Returns:
-      A list of gwibber compatible objects which have been parsed by _profile()
+    A list of Gwibber compatible objects which have been parsed by _profile().
+    
     """
     profiles = [self.profile(id)] or []
     messages = self._get("statuses/user_timeline.json", id=id, include_entities=1, count=count, since_id=since) or []