|
1 | 1 | # -*- coding: utf-8 -*-
|
2 |
| -""" |
3 |
| -github3.repos.repo |
4 |
| -================== |
| 2 | +"""This module contains Repository objects. |
5 | 3 |
|
6 |
| -This module contains the Repository object which is used to access the various |
7 |
| -parts of GitHub's Repository API. |
| 4 | +The Repository objects represent various different repository representations |
| 5 | +returned by GitHub. |
8 | 6 |
|
9 | 7 | """
|
10 | 8 | from __future__ import unicode_literals
|
@@ -1192,7 +1190,6 @@ def imported_issues(self, number=-1, since=None, etag=None):
|
1192 | 1190 | :returns: generator of :class:`ImportedIssue <github3.repos.
|
1193 | 1191 | issue_import.ImportedIssue>`
|
1194 | 1192 | """
|
1195 |
| - |
1196 | 1193 | data = {
|
1197 | 1194 | 'since': timestamp_parameter(since)
|
1198 | 1195 | }
|
@@ -1223,7 +1220,6 @@ def import_issue(self, title, body, created_at, assignee=None,
|
1223 | 1220 | :returns: :class:`ImportedIssue <github3.repos.
|
1224 | 1221 | issue_import.ImportedIssue>`
|
1225 | 1222 | """
|
1226 |
| - |
1227 | 1223 | issue = {
|
1228 | 1224 | 'issue': {
|
1229 | 1225 | 'title': title,
|
@@ -1421,7 +1417,7 @@ def latest_release(self):
|
1421 | 1417 | return self._instance_or_null(Release, json)
|
1422 | 1418 |
|
1423 | 1419 | def license(self):
|
1424 |
| - """Get the contents of a license for the repo |
| 1420 | + """Get the contents of a license for the repo. |
1425 | 1421 |
|
1426 | 1422 | :returns: :class:`License <github3.licenses.License>`
|
1427 | 1423 | """
|
@@ -1888,7 +1884,6 @@ class ShortRepository(_Repository):
|
1888 | 1884 |
|
1889 | 1885 |
|
1890 | 1886 | class Repository(_Repository):
|
1891 |
| - |
1892 | 1887 | """The :class:`Repository <Repository>` object.
|
1893 | 1888 |
|
1894 | 1889 | It represents how GitHub sends information about repositories.
|
@@ -2037,11 +2032,11 @@ def _update_attributes(self, repo):
|
2037 | 2032 |
|
2038 | 2033 |
|
2039 | 2034 | class StarredRepository(GitHubCore):
|
| 2035 | + """This object represents the data returned about a user's starred repos. |
2040 | 2036 |
|
2041 |
| - """The :class:`~github3.repos.repo.StarredRepository` object. |
2042 |
| -
|
2043 |
| - It represents how GitHub sends back a repository a user has starred, e.g., |
2044 |
| - from :meth:`~github3.users.User.starred_repositories`. |
| 2037 | + GitHub used to send back the ``starred_at`` attribute on Repositories but |
| 2038 | + then changed the structure to a new object that separates that from the |
| 2039 | + Repository representation. This consolidates the two. |
2045 | 2040 |
|
2046 | 2041 | See also:
|
2047 | 2042 | https://developer.github.com/v3/activity/starring/#list-repositories-being-starred
|
|
0 commit comments