Skip to content

Commit 286cf17

Browse files
author
Nat Williams
committed
add some docs I missed
1 parent 4ce1a90 commit 286cf17

File tree

5 files changed

+29
-9
lines changed

5 files changed

+29
-9
lines changed

pygithub3/requests/git_data/blobs.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,11 @@
55

66

77
class Get(Request):
8-
98
uri = 'repos/{user}/{repo}/git/blobs/{sha}'
109
resource = Blob
1110

1211

1312
class Create(Request):
14-
1513
uri = 'repos/{user}/{repo}/git/blobs'
1614
resource = Blob
1715
body_schema = {

pygithub3/requests/git_data/commits.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,3 @@ class Create(Request):
1616
'schema': ('message', 'tree', 'parents', 'author', 'committer'),
1717
'required': ('message', 'tree', 'parents'),
1818
}
19-
20-

pygithub3/services/git_data/blobs.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,22 @@ def get(self, sha, user=None, repo=None):
1111
"""Get a particular blob
1212
1313
:param str sha: The sha of the blob to get
14+
:param str user: Username
15+
:param str repo: Repository
1416
1517
"""
1618
request = self.make_request('git_data.blobs.get', sha=sha,
1719
user=user, repo=repo)
1820
return self._get(request)
1921

2022
def create(self, data, user=None, repo=None):
21-
"""Create a blob"""
23+
"""Create a blob
24+
25+
:param dict data: Data describing the blob to create
26+
:param str user: Username
27+
:param str repo: Repository
28+
29+
"""
2230
request = self.make_request('git_data.blobs.create', body=data,
2331
user=user, repo=repo)
2432
return self._post(request)

pygithub3/services/git_data/commits.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,13 @@ class Commits(Service):
88
"""Consume `Commits API <http://developer.github.com/v3/git/commits/>`_"""
99

1010
def get(self, sha, user=None, repo=None):
11-
"""get a commit from the current repo"""
11+
"""get a commit from the current repo
12+
13+
:param str sha: SHA of the Commit that you want.
14+
:param str user: Username
15+
:param str repo: Repository
16+
17+
"""
1218
request = self.make_request('git_data.commits.get', sha=sha,
1319
user=user, repo=repo)
1420
return self._get(request)

pygithub3/services/git_data/references.py

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ def get(self, ref, user=None, repo=None):
1313
.. note::
1414
Remember that branch references look like "heads/<branch_name>"
1515
16+
:param str ref: the name of the reference to get
17+
:param str user: Username
18+
:param str repo: Repository
19+
1620
"""
1721
return self._get(
1822
self.make_request('git_data.references.get', ref=ref, user=user,
@@ -24,6 +28,8 @@ def list(self, namespace='', user=None, repo=None):
2428
2529
:param str namespace: Limit the request to a particular type of
2630
reference. For example, ``heads`` or ``tags``.
31+
:param str user: Username
32+
:param str repo: Repository
2733
2834
"""
2935
return self._get(
@@ -34,8 +40,8 @@ def create(self, body, user=None, repo=None):
3440
"""Create a reference
3541
3642
:param dict body: Data describing the reference to create
37-
:param str user: username
38-
:param str repo: repository name
43+
:param str user: Username
44+
:param str repo: Repository
3945
4046
"""
4147
return self._post(
@@ -47,7 +53,9 @@ def update(self, ref, body, user=None, repo=None):
4753
"""Update an existing reference
4854
4955
:param str ref: The SHA of the reference to update
50-
:param dict body: data
56+
:param dict body: Data to update the reference with
57+
:param str user: Username
58+
:param str repo: Repository
5159
5260
"""
5361
return self._patch(
@@ -59,6 +67,8 @@ def delete(self, ref, user=None, repo=None):
5967
"""Delete a reference
6068
6169
:param str ref: The SHA of the reference to delete
70+
:param str user: Username
71+
:param str repo: Repository
6272
6373
"""
6474
return self._delete(

0 commit comments

Comments
 (0)