10000 Fix up github3.repos.repo docstrings · sacres/github3.py@b4211b0 · GitHub
[go: up one dir, main page]

Skip to content

Commit b4211b0

Browse files
committed
Fix up github3.repos.repo docstrings
1 parent 9a166b4 commit b4211b0

File tree

1 file changed

+8
-13
lines changed

1 file changed

+8
-13
lines changed

github3/repos/repo.py

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
# -*- coding: utf-8 -*-
2-
"""
3-
github3.repos.repo
4-
==================
2+
"""This module contains Repository objects.
53
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.
86
97
"""
108
from __future__ import unicode_literals
@@ -1192,7 +1190,6 @@ def imported_issues(self, number=-1, since=None, etag=None):
11921190
:returns: generator of :class:`ImportedIssue <github3.repos.
11931191
issue_import.ImportedIssue>`
11941192
"""
1195-
11961193
data = {
11971194
'since': timestamp_parameter(since)
11981195
}
@@ -1223,7 +1220,6 @@ def import_issue(self, title, body, created_at, assignee=None,
12231220
:returns: :class:`ImportedIssue <github3.repos.
12241221
issue_import.ImportedIssue>`
12251222
"""
1226-
12271223
issue = {
12281224
'issue': {
12291225
'title': title,
@@ -1421,7 +1417,7 @@ def latest_release(self):
14211417
return self._instance_or_null(Release, json)
14221418

14231419
def license(self):
1424-
"""Get the contents of a license for the repo
1420+
"""Get the contents of a license for the repo.
14251421
14261422
:returns: :class:`License <github3.licenses.License>`
14271423
"""
@@ -1888,7 +1884,6 @@ class ShortRepository(_Repository):
18881884

18891885

18901886
class Repository(_Repository):
1891-
18921887
"""The :class:`Repository <Repository>` object.
18931888
18941889
It represents how GitHub sends information about repositories.
@@ -2037,11 +2032,11 @@ def _update_attributes(self, repo):
20372032

20382033

20392034
class StarredRepository(GitHubCore):
2035+
"""This object represents the data returned about a user's starred repos.
20402036
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.
20452040
20462041
See also:
20472042
https://developer.github.com/v3/activity/starring/#list-repositories-being-starred

0 commit comments

Comments
 (0)
0