|
1 | 1 | # -*- 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.""" |
9 | 3 | from __future__ import unicode_literals
|
10 | 4 |
|
11 | 5 | from json import dumps
|
|
24 | 18 | class PullDestination(models.GitHubCore):
|
25 | 19 | """The :class:`PullDestination <PullDestination>` object.
|
26 | 20 |
|
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 |
28 | 25 | """
|
29 | 26 |
|
30 | 27 | def __init__(self, dest, direction):
|
@@ -58,7 +55,10 @@ class PullFile(models.GitHubCore):
|
58 | 55 |
|
59 | 56 | """The :class:`PullFile <PullFile>` object.
|
60 | 57 |
|
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 |
62 | 62 | """
|
63 | 63 |
|
64 | 64 | def _update_attributes(self, pfile):
|
@@ -108,17 +108,10 @@ class PullRequest(models.GitHubCore):
|
108 | 108 |
|
109 | 109 | """The :class:`PullRequest <PullRequest>` object.
|
110 | 110 |
|
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. |
117 | 112 |
|
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/ |
122 | 115 | """
|
123 | 116 |
|
124 | 117 | def _update_attributes(self, pull):
|
@@ -456,7 +449,10 @@ class PullReview(models.GitHubCore):
|
456 | 449 |
|
457 | 450 | """The :class:`PullReview <PullReview>` object.
|
458 | 451 |
|
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/ |
460 | 456 | """
|
461 | 457 |
|
462 | 458 | def _update_attributes(self, preview):
|
@@ -493,19 +489,10 @@ class ReviewComment(models.BaseComment):
|
493 | 489 |
|
494 | 490 | """The :class:`ReviewComment <ReviewComment>` object.
|
495 | 491 |
|
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. |
507 | 493 |
|
508 |
| - See also: http://developer.github.com/v3/pulls/comments/ |
| 494 | + .. _Pull Comments Documentation: |
| 495 | + http://developer.github.com/v3/pulls/comments/ |
509 | 496 | """
|
510 | 497 |
|
511 | 498 | def _update_attributes(self, comment):
|
|
0 commit comments