Improve documentation

This commit is contained in:
Vincent Jacques
2013-02-16 21:15:17 +01:00
parent 680490a6d8
commit 0bd00452e7
15 changed files with 97 additions and 106 deletions
+1 -1
View File
@@ -34,7 +34,7 @@ DEFAULT_TIMEOUT = 10
class Github(object):
"""
This class represents Githubs as returned for example by http://developer.github.com/v3/todo
This is the main class you instanciate to access the Github API v3. Optional parameters allow different authentication methods.
"""
def __init__(self, login_or_token=None, password=None, base_url=DEFAULT_BASE_URL, timeout=DEFAULT_TIMEOUT, client_id=None, client_secret=None, user_agent=None):