From 1240120c01723b832d6f22ac2e2f49d9bedc9670 Mon Sep 17 00:00:00 2001
From: Andrew Williams <andy@tensixtyone.com>
Date: Tue, 11 May 2010 13:13:19 +0100
Subject: [PATCH] Added some further documentation and examples

---
 reddit/api.py | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/reddit/api.py b/reddit/api.py
index 05e9a53..5d59b07 100644
--- a/reddit/api.py
+++ b/reddit/api.py
@@ -7,7 +7,7 @@ class NotLoggedIn(Exception):
     pass
 
 class Message(dict):
-    """ Reddit Message """
+    """ Abstract for a Reddit Message """
 
     def __init__(self, dict=None):
         if dict:
@@ -23,8 +23,15 @@ class Message(dict):
         return self.__unicode__()
 
 class Inbox():
-    """ Reddit Inbox class, accesses a user's inbox and provides a iterable 
-        list of messages """    
+    """
+    Reddit Inbox class, accesses a user's inbox and provides a iterable
+    list of messages
+
+    >>> inbox = Inbox(username='testuser', password='testpassword')
+    >>> len(inbox)
+    5
+
+    """
 
     REDDIT = "http://www.reddit.com"
     REDDIT_API_LOGIN = "%s/api/login" % REDDIT