Sprinkle in a few more docstrings

Author: Nick Groenen

err-secondlife.py

@@ -40,6 +40,7 @@ def get_configuration_template(self):
 
     @botcmd(split_args_with=None)
     def secondlife_friends(self, mess, args):
+        """Tells you which of your friends are currently online"""
         friends = self.mysl.friends_online()
         return str("You currently have {} friends online:\n{}".format(len(friends),
             "\n".join(friends).encode('utf-8', 'ignore')))

secondlife.py

@@ -26,6 +26,12 @@ class SigninError(MySecondLifeError):
 
 
 class MySecondLife(object):
+    """A wrapper around the SecondLife account pages (https://secondlife.com/my/account/)
+
+    Because SecondLife offers no API to a lot of the account-related data, we have
+    to make do with ugly html scraping that's bound to break horribly whenever
+    Linden Lab changes something.
+    """
     username = None
     password = None
 
@@ -37,7 +43,9 @@ def __init__(self, username, password):
         self._request_page('http://secondlife.com/my/account/') # Ensures we're logged in
 
     def _request_page(self, url):
-        """Requests an account-protected page"""
+        """Requests an account-protected page
+
+        Will perform a sign in if not yet signed in"""
         br = self.br
         br.open(url)
         if br.title() == "OpenId transaction in progress":
@@ -64,6 +72,7 @@ def _request_page(self, url):
         return BeautifulSoup(br.response().read())
 
     def _extract_friends_from_html_soup(self, soup):
+        """Extract online friends from the html of the friends-online page"""
         friends = []
         friendsoup = soup.find_all("div", class_="main-content-body")
         assert len(friendsoup) == 1
@@ -75,6 +84,7 @@ def _extract_friends_from_html_soup(self, soup):
         return friends
 
     def friends_online(self):
+        """Return a list of online friends"""
         html = self._request_page("https://secondlife.com/my/account/friends.php?")
         assert html.title.string == "Friends Online | Second Life"
         return self._extract_friends_from_html_soup(html)