aboutsummaryrefslogtreecommitdiffstats
path: root/pygithub3/services/git_data
diff options
context:
space:
mode:
authorNat Williams <nwilliams@leapfrogonline.com>2012-04-16 13:48:54 -0500
committerNat Williams <nwilliams@leapfrogonline.com>2012-04-16 13:48:54 -0500
commit286cf17b23890b709a7b55ecb21148af88577779 (patch)
treeea07ebb06e78d9385ed23ea178e6138b213fb6d9 /pygithub3/services/git_data
parentadd Git Data API support (diff)
downloadpython-github3-286cf17b23890b709a7b55ecb21148af88577779.tar.xz
python-github3-286cf17b23890b709a7b55ecb21148af88577779.zip
add some docs I missed
Diffstat (limited to 'pygithub3/services/git_data')
-rw-r--r--pygithub3/services/git_data/blobs.py10
-rw-r--r--pygithub3/services/git_data/commits.py8
-rw-r--r--pygithub3/services/git_data/references.py16
3 files changed, 29 insertions, 5 deletions
diff --git a/pygithub3/services/git_data/blobs.py b/pygithub3/services/git_data/blobs.py
index d5baa2d..4f1a6e7 100644
--- a/pygithub3/services/git_data/blobs.py
+++ b/pygithub3/services/git_data/blobs.py
@@ -11,6 +11,8 @@ class Blobs(Service):
"""Get a particular blob
:param str sha: The sha of the blob to get
+ :param str user: Username
+ :param str repo: Repository
"""
request = self.make_request('git_data.blobs.get', sha=sha,
@@ -18,7 +20,13 @@ class Blobs(Service):
return self._get(request)
def create(self, data, user=None, repo=None):
- """Create a blob"""
+ """Create a blob
+
+ :param dict data: Data describing the blob to create
+ :param str user: Username
+ :param str repo: Repository
+
+ """
request = self.make_request('git_data.blobs.create', body=data,
user=user, repo=repo)
return self._post(request)
diff --git a/pygithub3/services/git_data/commits.py b/pygithub3/services/git_data/commits.py
index cdca300..4debd95 100644
--- a/pygithub3/services/git_data/commits.py
+++ b/pygithub3/services/git_data/commits.py
@@ -8,7 +8,13 @@ class Commits(Service):
"""Consume `Commits API <http://developer.github.com/v3/git/commits/>`_"""
def get(self, sha, user=None, repo=None):
- """get a commit from the current repo"""
+ """get a commit from the current repo
+
+ :param str sha: SHA of the Commit that you want.
+ :param str user: Username
+ :param str repo: Repository
+
+ """
request = self.make_request('git_data.commits.get', sha=sha,
user=user, repo=repo)
return self._get(request)
diff --git a/pygithub3/services/git_data/references.py b/pygithub3/services/git_data/references.py
index 8ae0865..3a24f90 100644
--- a/pygithub3/services/git_data/references.py
+++ b/pygithub3/services/git_data/references.py
@@ -13,6 +13,10 @@ class References(Service):
.. note::
Remember that branch references look like "heads/<branch_name>"
+ :param str ref: the name of the reference to get
+ :param str user: Username
+ :param str repo: Repository
+
"""
return self._get(
self.make_request('git_data.references.get', ref=ref, user=user,
@@ -24,6 +28,8 @@ class References(Service):
:param str namespace: Limit the request to a particular type of
reference. For example, ``heads`` or ``tags``.
+ :param str user: Username
+ :param str repo: Repository
"""
return self._get(
@@ -34,8 +40,8 @@ class References(Service):
"""Create a reference
:param dict body: Data describing the reference to create
- :param str user: username
- :param str repo: repository name
+ :param str user: Username
+ :param str repo: Repository
"""
return self._post(
@@ -47,7 +53,9 @@ class References(Service):
"""Update an existing reference
:param str ref: The SHA of the reference to update
- :param dict body: data
+ :param dict body: Data to update the reference with
+ :param str user: Username
+ :param str repo: Repository
"""
return self._patch(
@@ -59,6 +67,8 @@ class References(Service):
"""Delete a reference
:param str ref: The SHA of the reference to delete
+ :param str user: Username
+ :param str repo: Repository
"""
return self._delete(