Added some further documentation and examples

This commit is contained in:
2010-05-11 13:13:19 +01:00
parent be978a43aa
commit 1240120c01

View File

@@ -7,7 +7,7 @@ class NotLoggedIn(Exception):
pass pass
class Message(dict): class Message(dict):
""" Reddit Message """ """ Abstract for a Reddit Message """
def __init__(self, dict=None): def __init__(self, dict=None):
if dict: if dict:
@@ -23,8 +23,15 @@ class Message(dict):
return self.__unicode__() return self.__unicode__()
class Inbox(): 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 = "http://www.reddit.com"
REDDIT_API_LOGIN = "%s/api/login" % REDDIT REDDIT_API_LOGIN = "%s/api/login" % REDDIT