Gists services doc

copitux · copitux · commit 37e871617148 · 2012-04-03T23:18:52.000+02:00
diff --git a/docs/gists.rst b/docs/gists.rst
@@ -0,0 +1,37 @@
+.. _Gists service:
+
+Gists services
+===============
+
+**Fast sample**::
+
+    from pygithub3 import Github
+
+    auth = dict(login='octocat', password='pass')
+    gh = Github(**auth)
+
+    octocat_gists = gh.gists.list()
+    the_first_gist = gh.gists.get(1)
+
+    the_first_gist_comments = gh.gists.comments.list(1)
+
+Gist
+-----
+
+.. autoclass:: pygithub3.services.gists.Gist
+    :members:
+
+    .. attribute:: comments
+
+        :ref:`Comments service`
+
+.. _Comments service:
+
+Comments
+----------
+
+.. autoclass:: pygithub3.services.gists.Comments
+    :members:
+
+.. _github gists doc: http://developer.github.com/v3/gists
+.. _github comments doc: http://developer.github.com/v3/gists/comments
diff --git a/docs/services.rst b/docs/services.rst
@@ -61,5 +61,6 @@ List of services
 
     users
     repos
+    gists
 
 .. _mimetypes: http://developer.github.com/v3/mime
diff --git a/pygithub3/services/gists/__init__.py b/pygithub3/services/gists/__init__.py
@@ -96,6 +96,10 @@ def star(self, id):
         """ Star a gist
 
         :param int id: Gist id
+
+        .. warning ::
+            You must be authenticated
+
         """
         request = self.request_builder('gists.star', id=id)
         self._put(request)
@@ -104,6 +108,10 @@ def unstar(self, id):
         """ Unstar a gist
 
         :param int id: Gist id
+
+        .. warning ::
+            You must be authenticated
+
         """
         request = self.request_builder('gists.unstar', id=id)
         return self._delete(request)
@@ -112,6 +120,10 @@ def is_starred(self, id):
         """ Check if a gist is starred
 
         :param int id: Gist id
+
+        .. warning ::
+            You must be authenticated
+
         """
         request = self.request_builder('gists.is_starred', id=id)
         return self._bool(request)
@@ -120,6 +132,10 @@ def fork(self, id):
         """ Fork a gist
 
         :param int id: Gist id
+
+        .. warning ::
+            You must be authenticated
+
         """
 
         request = self.request_builder('gists.fork', id=id)
@@ -129,6 +145,10 @@ def delete(self, id):
         """ Delete a gist
 
         :param int id: Gist id
+
+        .. warning ::
+            You must be authenticated
+
         """
         request = self.request_builder('gists.delete', id=id)
         return self._delete(request)
diff --git a/pygithub3/services/gists/comments.py b/pygithub3/services/gists/comments.py
@@ -39,6 +39,7 @@ def create(self, gist_id, message):
             You must be authenticated
 
         ::
+
             comment_service.create(1, 'comment')
         """
         request = self.request_builder('gists.comments.create',
@@ -50,6 +51,9 @@ def update(self, id, message):
 
         :param int id: Comment id
         :param str message: Comment's message
+
+        .. warning::
+            You must be authenticated
         """
         request = self.request_builder('gists.comments.update', id=id,
             body={'body': message})
@@ -59,6 +63,9 @@ def delete(self, id):
         """ Delete a comment
 
         :param int id: Comment id
+
+        .. warning::
+            You must be authenticated
         """
         request = self.request_builder('gists.comments.delete', id=id)
         self._delete(request)

-Original file line number
+Diff line change
     users
     repos
 +    gists
 .. _mimetypes: http://developer.github.com/v3/mime