Skip to content

Commit 511675f

Browse files
committed
Update docstrings for pulls.py
Related-to sigmavirus24#670 Signed-off-by: Jesse Keating <jkeating@j2solutions.net>
1 parent 6a0470c commit 511675f

File tree

1 file changed

+19
-32
lines changed

1 file changed

+19
-32
lines changed

github3/pulls.py

Lines changed: 19 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,5 @@
11
# -*- coding: utf-8 -*-
2-
"""
3-
github3.pulls
4-
=============
5-
6-
This module contains all the classes relating to pull requests.
7-
8-
"""
2+
"""This module contains all the classes relating to pull requests."""
93
from __future__ import unicode_literals
104

115
from json import dumps
@@ -24,7 +18,10 @@
2418
class PullDestination(models.GitHubCore):
2519
"""The :class:`PullDestination <PullDestination>` object.
2620
27-
See also: http://developer.github.com/v3/pulls/#get-a-single-pull-request
21+
Please see GitHub's `PullRequest Documentation`_ for more information.
22+
23+
.. _PullRequest Documentation:
24+
http://developer.github.com/v3/pulls/#get-a-single-pull-request
2825
"""
2926

3027
def __init__(self, dest, direction):
@@ -58,7 +55,10 @@ class PullFile(models.GitHubCore):
5855

5956
"""The :class:`PullFile <PullFile>` object.
6057
61-
See also: http://developer.github.com/v3/pulls/#list-pull-requests-files
58+
Please see GitHub's `PR Files Documentation`_ for more information.
59+
60+
.. _PR Files Documentation:
61+
http://developer.github.com/v3/pulls/#list-pull-requests-files
6262
"""
6363

6464
def _update_attributes(self, pfile):
@@ -108,17 +108,10 @@ class PullRequest(models.GitHubCore):
108108

109109
"""The :class:`PullRequest <PullRequest>` object.
110110
111-
Two pull request instances can be checked like so::
112-
113-
p1 == p2
114-
p1 != p2
115-
116-
And is equivalent to::
111+
Please see GitHub's `PullRequests Documentation`_ for more information.
117112
118-
p1.id == p2.id
119-
p1.id != p2.id
120-
121-
See also: http://developer.github.com/v3/pulls/
113+
.. _PullRequests Documentation:
114+
http://developer.github.com/v3/pulls/
122115
"""
123116

124117
def _update_attributes(self, pull):
@@ -456,7 +449,10 @@ class PullReview(models.GitHubCore):
456449

457450
"""The :class:`PullReview <PullReview>` object.
458451
459-
See also: https://developer.github.com/v3/pulls/reviews/
452+
Please see GitHub's `PullReview Documentation`_ for more information.
453+
454+
.. _PullReview Documentation:
455+
https://developer.github.com/v3/pulls/reviews/
460456
"""
461457

462458
def _update_attributes(self, preview):
@@ -493,19 +489,10 @@ class ReviewComment(models.BaseComment):
493489

494490
"""The :class:`ReviewComment <ReviewComment>` object.
495491
496-
This is used to represent comments on pull requests.
497-
498-
Two comment instances can be checked like so::
499-
500-
c1 == c2
501-
c1 != c2
502-
503-
And is equivalent to::
504-
505-
c1.id == c2.id
506-
c1.id != c2.id
492+
Please see GitHub's `Pull Comments Documentation`_ for more information.
507493
508-
See also: http://developer.github.com/v3/pulls/comments/
494+
.. _Pull Comments Documentation:
495+
http://developer.github.com/v3/pulls/comments/
509496
"""
510497

511498
def _update_attributes(self, comment):

0 commit comments

Comments
 (0)