aboutsummaryrefslogtreecommitdiffstats
path: root/pygithub3
diff options
context:
space:
mode:
authorDavid Medina <davidmedina9@gmail.com>2012-04-03 23:18:52 +0200
committerDavid Medina <davidmedina9@gmail.com>2012-04-03 23:18:52 +0200
commit37e871617148bfde801a499699bbf2205125d830 (patch)
treec38c9fded3b56554d2a22fe1f7712dab9be6dca9 /pygithub3
parentFix naming (diff)
downloadpython-github3-37e871617148bfde801a499699bbf2205125d830.tar.xz
python-github3-37e871617148bfde801a499699bbf2205125d830.zip
Gists services doc
Diffstat (limited to 'pygithub3')
-rw-r--r--pygithub3/services/gists/__init__.py20
-rw-r--r--pygithub3/services/gists/comments.py7
2 files changed, 27 insertions, 0 deletions
diff --git a/pygithub3/services/gists/__init__.py b/pygithub3/services/gists/__init__.py
index 5fbfe7a..aadb136 100644
--- a/pygithub3/services/gists/__init__.py
+++ b/pygithub3/services/gists/__init__.py
@@ -96,6 +96,10 @@ class Gist(Service):
""" 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 @@ class Gist(Service):
""" 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 @@ class Gist(Service):
""" 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 @@ class Gist(Service):
""" 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 @@ class Gist(Service):
""" 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
index 397d583..7f4955f 100644
--- a/pygithub3/services/gists/comments.py
+++ b/pygithub3/services/gists/comments.py
@@ -39,6 +39,7 @@ class Comments(Service, MimeTypeMixin):
You must be authenticated
::
+
comment_service.create(1, 'comment')
"""
request = self.request_builder('gists.comments.create',
@@ -50,6 +51,9 @@ class Comments(Service, MimeTypeMixin):
: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 @@ class Comments(Service, MimeTypeMixin):
""" 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)