Reformat client.Github docstring for use in Sphinx.

JNRowe · JNRowe · commit c463aa3f6e62 · 2011-04-12T11:19:34.000+01:00
diff --git a/doc/api/client.rst b/doc/api/client.rst
@@ -1,6 +1,12 @@
 Creating a client
 =================
 
+.. autoclass:: github2.client.Github
+   :members:
+
+Examples
+--------
+
 There are three ways to authenticate to the GitHub API.  If you want to use your
 username and API token, use::
 
diff --git a/doc/conf.py b/doc/conf.py
@@ -215,3 +215,5 @@
     ('index', 'python-github2', u'python-github2 Documentation',
      [u'Ask Solem'], 1)
 ]
+
+autoclass_content = "init"
diff --git a/github2/client.py b/github2/client.py
@@ -12,26 +12,20 @@ def __init__(self, username=None, api_token=None, debug=False,
         """
         An interface to GitHub's API:
             http://develop.github.com/
-        
-        Params:
-            `username` is your own GitHub username.
-    
-            `api_token` can be found here (while logged in as that user):
-                https://github.com/account
-
-            `access_token` can be used when no ``username`` and/or ``api_token``
-                is used.  The ``access_token`` is the OAuth access token that is
-                received after successful OAuth authentication.
-    
-            `requests_per_second` is a float indicating the API rate limit
-                you're operating under (1 per second per GitHub at the moment),
-                or None to disable delays.
 
-                The default is to disable delays (for backwards compatibility).
-
-            `cache` is a directory for caching GitHub responses.
+        :param str username: your own GitHub username.
+        :param str api_token: can be found at https://github.com/account
+            (while logged in as that user):
+        :param str access_token: can be used when no ``username`` and/or
+            ``api_token`` is used.  The ``access_token`` is the OAuth access
+            token that is received after successful OAuth authentication.
+        :param float requests_per_second: indicate the API rate limit you're
+            operating under (1 per second per GitHub at the moment),
+            or None to disable delays.  The default is to disable delays (for
+            backwards compatibility).
+        :param str cache: a directory for caching GitHub responses.
         """
-        
+
         self.debug = debug
         self.request = GithubRequest(username=username, api_token=api_token,
                                      debug=self.debug,

Original file line number	Diff line number	Diff line change
`@@ -215,3 +215,5 @@`
`215`	`215`	`('index', 'python-github2', u'python-github2 Documentation',`
`216`	`216`	`[u'Ask Solem'], 1)`
`217`	`217`	`]`
	`218`	`+`
	`219`	`+autoclass_content = "init"`