Skip to content

Commit 0b69270

Browse files
committed
All that's left is the user module.
Oh and I'll do the search module as I write it.
1 parent c32280b commit 0b69270

2 files changed

Lines changed: 39 additions & 0 deletions

File tree

docs/pulls.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,18 @@ Pull Request Objects
1616

1717
.. autoclass:: PullRequest
1818
:inherited-members:
19+
20+
------
21+
22+
.. autoclass:: ReviewComment
23+
:inherited-members:
24+
25+
------
26+
27+
.. autoclass:: PullDestination
28+
:inherited-members:
29+
30+
------
31+
32+
.. autoclass:: PullFile
33+
:inherited-members:

github3/pulls.py

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313

1414

1515
class PullDestination(GitHubCore):
16+
"""The :class:`PullDestination <PullDestination>` object."""
1617
def __init__(self, dest, direction):
1718
super(PullDestination, self).__init__(None)
1819
self._dir = direction
@@ -33,26 +34,32 @@ def __repr__(self):
3334

3435
@property
3536
def label(self):
37+
"""label of the destination"""
3638
return self._label
3739

3840
@property
3941
def sha(self):
42+
"""SHA of the commit at the head"""
4043
return self._sha
4144

4245
@property
4346
def ref(self):
47+
"""Full reference string of the object"""
4448
return self._ref
4549

4650
@property
4751
def repo(self):
52+
"""(owner, name) representing the repository this is on"""
4853
return (self._repo_owner, self._repo_name)
4954

5055
@property
5156
def user(self):
57+
""":class:`User <user.User>` representing the owner"""
5258
return self._user
5359

5460

5561
class PullFile(object):
62+
"""The :class:`PullFile <PullFile>` object."""
5663
def __init__(self, pfile):
5764
super(PullFile, self).__init__()
5865
self._sha = pfile.get('sha')
@@ -70,38 +77,47 @@ def __repr__(self):
7077

7178
@property
7279
def additions(self):
80+
"""Number of additions on this file"""
7381
return self._add
7482

7583
@property
7684
def blob_url(self):
85+
"""URL to view the blob for this file"""
7786
return self._blob
7887

7988
@property
8089
def changes(self):
90+
"""Number of changes made to this file"""
8191
return self._changes
8292

8393
@property
8494
def deletions(self):
95+
"""Number of deletions on this file"""
8596
return self._del
8697

8798
@property
8899
def filename(self):
100+
"""Name of the file"""
89101
return self._name
90102

91103
@property
92104
def patch(self):
105+
"""URL to view the patch"""
93106
return self._patch
94107

95108
@property
96109
def raw_url(self):
110+
"""URL to view the raw diff of this file"""
97111
return self._raw
98112

99113
@property
100114
def sha(self):
115+
"""SHA of the commit"""
101116
return self._sha
102117

103118
@property
104119
def status(self):
120+
"""Status of the file, e.g., 'added'"""
105121
return self._status
106122

107123

@@ -318,6 +334,9 @@ def user(self):
318334

319335

320336
class ReviewComment(BaseComment):
337+
"""The :class:`ReviewComment <ReviewComment>` object. This is used to
338+
represent comments on pull requests.
339+
"""
321340
def __init__(self, comment, session):
322341
super(ReviewComment, self).__init__(comment, session)
323342

@@ -326,20 +345,25 @@ def __repr__(self):
326345

327346
@property
328347
def commit_id(self):
348+
"""SHA of the commit the comment is on"""
329349
return self._cid
330350

331351
@property
332352
def html_url(self):
353+
"""URL of the comment"""
333354
return self._url
334355

335356
@property
336357
def path(self):
358+
"""Path to the file"""
337359
return self._path
338360

339361
@property
340362
def position(self):
363+
"""Position within the commit"""
341364
return self._pos
342365

343366
@property
344367
def updated_at(self):
368+
"""datetime object representing the last time the object was updated."""
345369
return self._updated

0 commit comments

Comments
 (0)