aboutsummaryrefslogtreecommitdiffstats
path: root/pygithub3/services/repos/commits.py
diff options
context:
space:
mode:
authorDavid Medina <davidmedina9@gmail.com>2012-03-01 19:41:46 +0100
committerDavid Medina <davidmedina9@gmail.com>2012-03-01 19:43:26 +0100
commit5d7ee35eb23f193ec79a1a7b24ea87c6f1bc28b8 (patch)
treec90ab9489c5217151c1f1c716aea8fa39b303393 /pygithub3/services/repos/commits.py
parentWIP on services.repos doc (diff)
downloadpython-github3-5d7ee35eb23f193ec79a1a7b24ea87c6f1bc28b8.tar.xz
python-github3-5d7ee35eb23f193ec79a1a7b24ea87c6f1bc28b8.zip
Complete services.repos doc
Also add Mimetypes doc
Diffstat (limited to 'pygithub3/services/repos/commits.py')
-rw-r--r--pygithub3/services/repos/commits.py14
1 files changed, 7 insertions, 7 deletions
diff --git a/pygithub3/services/repos/commits.py b/pygithub3/services/repos/commits.py
index 23e6842..8eec3e7 100644
--- a/pygithub3/services/repos/commits.py
+++ b/pygithub3/services/repos/commits.py
@@ -25,7 +25,6 @@ class Commits(Service, MimeTypeMixin):
:param str repo: Repository
.. note::
-
Remember :ref:`config precedence`
"""
request = self.make_request('repos.commits.get',
@@ -38,9 +37,9 @@ class Commits(Service, MimeTypeMixin):
:param str sha: Commit's sha
:param str user: Username
:param str repo: Repository
+ :returns: A :doc:`result`
.. note::
-
Remember :ref:`config precedence`
If you call it without ``sha``, get all commit's comments of a
@@ -64,9 +63,11 @@ class Commits(Service, MimeTypeMixin):
:param str repo: Repository
.. note::
-
Remember :ref:`config precedence`
+ .. warning::
+ You must be authenticated
+
::
data = {
@@ -91,7 +92,6 @@ class Commits(Service, MimeTypeMixin):
:param str repo: Repository
.. note::
-
Remember :ref:`config precedence`
"""
request = self.make_request('repos.commits.get_comment',
@@ -107,9 +107,11 @@ class Commits(Service, MimeTypeMixin):
:param str repo: Repository
.. note::
-
Remember :ref:`config precedence`
+ .. warning::
+ You must be authenticated
+
::
commits_service.update_comment(dict(body='nice change'), 42,
@@ -128,7 +130,6 @@ class Commits(Service, MimeTypeMixin):
:param str repo: Repository
.. note::
-
Remember :ref:`config precedence`
::
@@ -148,7 +149,6 @@ class Commits(Service, MimeTypeMixin):
:param str repo: Repository
.. note::
-
Remember :ref:`config precedence`
"""
request = self.make_request('repos.commits.delete_comment',