diff --git a/github/AuthenticatedUser.py b/github/AuthenticatedUser.py index 4aaf60c2..9c91a6e2 100644 --- a/github/AuthenticatedUser.py +++ b/github/AuthenticatedUser.py @@ -45,7 +45,7 @@ import github.Notification class AuthenticatedUser(github.GithubObject.CompletableGithubObject): """ - This class represents AuthenticatedUsers as returned for example by http://developer.github.com/v3/todo + This class represents AuthenticatedUsers as returned by https://developer.github.com/v3/users/#get-the-authenticated-user An AuthenticatedUser object can be created by calling ``get_user()`` on a Github object. """ diff --git a/github/Authorization.py b/github/Authorization.py index 11b4d9b4..1269eacb 100644 --- a/github/Authorization.py +++ b/github/Authorization.py @@ -32,7 +32,7 @@ import github.AuthorizationApplication class Authorization(github.GithubObject.CompletableGithubObject): """ - This class represents Authorizations as returned for example by http://developer.github.com/v3/todo + This class represents Authorizations. The reference can be found here https://developer.github.com/v3/oauth_authorizations/ """ def __repr__(self): diff --git a/github/AuthorizationApplication.py b/github/AuthorizationApplication.py index 63445fbf..a2fbcfdd 100644 --- a/github/AuthorizationApplication.py +++ b/github/AuthorizationApplication.py @@ -30,7 +30,7 @@ import github.GithubObject class AuthorizationApplication(github.GithubObject.CompletableGithubObject): """ - This class represents AuthorizationApplications as returned for example by http://developer.github.com/v3/todo + This class represents AuthorizationApplications """ def __repr__(self): diff --git a/github/Branch.py b/github/Branch.py index effc5bf6..4372eda8 100644 --- a/github/Branch.py +++ b/github/Branch.py @@ -33,7 +33,7 @@ import github.Commit class Branch(github.GithubObject.NonCompletableGithubObject): """ - This class represents Branchs. The reference can be found here http://developer.github.com/v3/repos/#list-branches + This class represents Branches. The reference can be found here http://developer.github.com/v3/repos/#list-branches """ def __repr__(self): diff --git a/github/CommitCombinedStatus.py b/github/CommitCombinedStatus.py index c2ef2967..294649c6 100644 --- a/github/CommitCombinedStatus.py +++ b/github/CommitCombinedStatus.py @@ -33,7 +33,7 @@ import github.Repository class CommitCombinedStatus(github.GithubObject.NonCompletableGithubObject): """ - This class represents CommitCombinedStatus as returned for example by https://developer.github.com/v3/repos/statuses/ + This class represents CommitCombinedStatuses. The reference can be found here https://developer.github.com/v3/repos/statuses/#get-the-combined-status-for-a-specific-ref """ def __repr__(self): diff --git a/github/CommitComment.py b/github/CommitComment.py index 088d2e42..ae6e2501 100644 --- a/github/CommitComment.py +++ b/github/CommitComment.py @@ -32,7 +32,7 @@ import github.NamedUser class CommitComment(github.GithubObject.CompletableGithubObject): """ - This class represents CommitComments as returned for example by http://developer.github.com/v3/todo + This class represents CommitComments. The reference can be found here https://developer.github.com/v3/repos/comments/ """ def __repr__(self): diff --git a/github/CommitStats.py b/github/CommitStats.py index d8a2a3ce..6bcd082e 100644 --- a/github/CommitStats.py +++ b/github/CommitStats.py @@ -30,7 +30,7 @@ import github.GithubObject class CommitStats(github.GithubObject.NonCompletableGithubObject): """ - This class represents CommitStatss as returned for example by http://developer.github.com/v3/todo + This class represents CommitStatses. """ @property diff --git a/github/CommitStatus.py b/github/CommitStatus.py index ff43d695..0e17dfe1 100644 --- a/github/CommitStatus.py +++ b/github/CommitStatus.py @@ -32,7 +32,7 @@ import github.NamedUser class CommitStatus(github.GithubObject.NonCompletableGithubObject): """ - This class represents CommitStatuss as returned for example by https://developer.github.com/v3/repos/statuses/ + This class represents CommitStatuses.The reference can be found here https://developer.github.com/v3/repos/statuses/ """ def __repr__(self): diff --git a/github/Comparison.py b/github/Comparison.py index bee42c73..67d522c1 100644 --- a/github/Comparison.py +++ b/github/Comparison.py @@ -33,7 +33,7 @@ import github.File class Comparison(github.GithubObject.CompletableGithubObject): """ - This class represents Comparisons as returned for example by http://developer.github.com/v3/todo + This class represents Comparisons """ @property diff --git a/github/Consts.py b/github/Consts.py index 2c1a169a..e436a3cd 100644 --- a/github/Consts.py +++ b/github/Consts.py @@ -23,13 +23,6 @@ # # # ############################################################################## -# #193: Line endings should be linux style - -# TODO: As of Thu Aug 21 22:40:13 (BJT) Chinese Standard Time 2013 -# lots of consts in this project are explict -# should realy round them up and reference them by consts -# EDIT: well, maybe :-) - # ############################################################################## # Request Header # # (Case sensitive) # diff --git a/github/ContentFile.py b/github/ContentFile.py index 2f69946b..b4f67682 100644 --- a/github/ContentFile.py +++ b/github/ContentFile.py @@ -37,7 +37,7 @@ atLeastPython3 = sys.hexversion >= 0x03000000 class ContentFile(github.GithubObject.CompletableGithubObject): """ - This class represents ContentFiles as returned for example by http://developer.github.com/v3/todo + This class represents ContentFiles. The reference can be found here https://developer.github.com/v3/repos/contents/#get-contents """ def __repr__(self): diff --git a/github/Download.py b/github/Download.py index 49acc489..fcf8316d 100644 --- a/github/Download.py +++ b/github/Download.py @@ -30,7 +30,7 @@ import github.GithubObject class Download(github.GithubObject.CompletableGithubObject): """ - This class represents Downloads as returned for example by http://developer.github.com/v3/todo + This class represents Downloads. The reference can be found here https://developer.github.com/v3/repos/downloads/ """ def __repr__(self): diff --git a/github/File.py b/github/File.py index 15454099..e1c2b38b 100644 --- a/github/File.py +++ b/github/File.py @@ -30,7 +30,7 @@ import github.GithubObject class File(github.GithubObject.NonCompletableGithubObject): """ - This class represents Files as returned for example by http://developer.github.com/v3/todo + This class represents Files """ def __repr__(self): diff --git a/github/Gist.py b/github/Gist.py index 8d75e1e1..6e4e0238 100644 --- a/github/Gist.py +++ b/github/Gist.py @@ -37,7 +37,7 @@ import github.GistHistoryState class Gist(github.GithubObject.CompletableGithubObject): """ - This class represents Gists as returned for example by http://developer.github.com/v3/todo + This class represents Gists. The reference can be found here https://developer.github.com/v3/gists/ """ def __repr__(self): diff --git a/github/GistComment.py b/github/GistComment.py index be1d08f7..1f8c83ef 100644 --- a/github/GistComment.py +++ b/github/GistComment.py @@ -32,7 +32,7 @@ import github.NamedUser class GistComment(github.GithubObject.CompletableGithubObject): """ - This class represents GistComments as returned for example by http://developer.github.com/v3/todo + This class represents GistComments. The reference can be found here https://developer.github.com/v3/gists/comments/ """ def __repr__(self): diff --git a/github/GistFile.py b/github/GistFile.py index 5778acfc..cecba994 100644 --- a/github/GistFile.py +++ b/github/GistFile.py @@ -30,7 +30,7 @@ import github.GithubObject class GistFile(github.GithubObject.NonCompletableGithubObject): """ - This class represents GistFiles as returned for example by http://developer.github.com/v3/todo + This class represents GistFiles """ def __repr__(self): diff --git a/github/GistHistoryState.py b/github/GistHistoryState.py index 137462a6..adeee6fa 100644 --- a/github/GistHistoryState.py +++ b/github/GistHistoryState.py @@ -34,7 +34,7 @@ import github.Gist class GistHistoryState(github.GithubObject.CompletableGithubObject): """ - This class represents GistHistoryStates as returned for example by http://developer.github.com/v3/todo + This class represents GistHistoryStates """ @property diff --git a/github/GitAuthor.py b/github/GitAuthor.py index 324dcc14..2b3ee0c3 100644 --- a/github/GitAuthor.py +++ b/github/GitAuthor.py @@ -30,7 +30,7 @@ import github.GithubObject class GitAuthor(github.GithubObject.NonCompletableGithubObject): """ - This class represents GitAuthors as returned for example by http://developer.github.com/v3/todo + This class represents GitAuthors """ def __repr__(self): diff --git a/github/GitBlob.py b/github/GitBlob.py index 3de1c6fb..107f5972 100644 --- a/github/GitBlob.py +++ b/github/GitBlob.py @@ -30,7 +30,7 @@ import github.GithubObject class GitBlob(github.GithubObject.CompletableGithubObject): """ - This class represents GitBlobs as returned for example by http://developer.github.com/v3/todo + This class represents GitBlobs. The reference can be found here https://developer.github.com/v3/git/blobs/ """ def __repr__(self): diff --git a/github/GitCommit.py b/github/GitCommit.py index 9d43d51b..187d9e02 100644 --- a/github/GitCommit.py +++ b/github/GitCommit.py @@ -33,7 +33,7 @@ import github.GitTree class GitCommit(github.GithubObject.CompletableGithubObject): """ - This class represents GitCommits as returned for example by http://developer.github.com/v3/todo + This class represents GitCommits. The reference can be found here https://developer.github.com/v3/git/commits/ """ def __repr__(self): diff --git a/github/GitObject.py b/github/GitObject.py index 0850061b..64199106 100644 --- a/github/GitObject.py +++ b/github/GitObject.py @@ -30,7 +30,7 @@ import github.GithubObject class GitObject(github.GithubObject.NonCompletableGithubObject): """ - This class represents GitObjects as returned for example by http://developer.github.com/v3/todo + This class represents GitObjects """ def __repr__(self): diff --git a/github/GitRef.py b/github/GitRef.py index 417982fe..51e0b61c 100644 --- a/github/GitRef.py +++ b/github/GitRef.py @@ -32,7 +32,7 @@ import github.GitObject class GitRef(github.GithubObject.CompletableGithubObject): """ - This class represents GitRefs as returned for example by http://developer.github.com/v3/todo + This class represents GitRefs. The reference can be found here https://developer.github.com/v3/git/refs/ """ def __repr__(self): diff --git a/github/GitRelease.py b/github/GitRelease.py index 8af90a85..dd49cccd 100644 --- a/github/GitRelease.py +++ b/github/GitRelease.py @@ -30,7 +30,7 @@ import github.GitReleaseAsset class GitRelease(github.GithubObject.CompletableGithubObject): """ - This class represents GitRelease as returned for example by https://developer.github.com/v3/repos/releases + This class represents GitReleases. The reference can be found here https://developer.github.com/v3/repos/releases """ def __repr__(self): diff --git a/github/GitReleaseAsset.py b/github/GitReleaseAsset.py index 708e7e17..220c8958 100644 --- a/github/GitReleaseAsset.py +++ b/github/GitReleaseAsset.py @@ -31,10 +31,7 @@ import github.GithubObject class GitReleaseAsset(github.GithubObject.CompletableGithubObject): """ - This class represents GitReleaseAssets as returned by - GET /repos/:owner/:repo/releases/assets/:id - See: - https://developer.github.com/v3/repos/releases/#get-a-single-release-asset + This class represents GitReleaseAssets. The reference can be found here https://developer.github.com/v3/repos/releases/#get-a-single-release-asset """ def __repr__(self): diff --git a/github/GitTag.py b/github/GitTag.py index 347fd247..5c10a078 100644 --- a/github/GitTag.py +++ b/github/GitTag.py @@ -33,7 +33,7 @@ import github.GitObject class GitTag(github.GithubObject.CompletableGithubObject): """ - This class represents GitTags as returned for example by http://developer.github.com/v3/todo + This class represents GitTags. The reference can be found here https://developer.github.com/v3/git/tags/ """ def __repr__(self): diff --git a/github/GitTree.py b/github/GitTree.py index 8012bb77..4e8ec6a1 100644 --- a/github/GitTree.py +++ b/github/GitTree.py @@ -32,7 +32,7 @@ import github.GitTreeElement class GitTree(github.GithubObject.CompletableGithubObject): """ - This class represents GitTrees as returned for example by http://developer.github.com/v3/todo + This class represents GitTrees. The reference can be found here https://developer.github.com/v3/git/trees/ """ def __repr__(self): diff --git a/github/GitTreeElement.py b/github/GitTreeElement.py index 907fb58f..e86af240 100644 --- a/github/GitTreeElement.py +++ b/github/GitTreeElement.py @@ -30,7 +30,7 @@ import github.GithubObject class GitTreeElement(github.GithubObject.NonCompletableGithubObject): """ - This class represents GitTreeElements as returned for example by http://developer.github.com/v3/todo + This class represents GitTreeElements """ def __repr__(self): diff --git a/github/GitignoreTemplate.py b/github/GitignoreTemplate.py index 55353dc3..19cb6a2a 100644 --- a/github/GitignoreTemplate.py +++ b/github/GitignoreTemplate.py @@ -29,7 +29,7 @@ import github.GithubObject class GitignoreTemplate(github.GithubObject.NonCompletableGithubObject): """ - This class represents GitignoreTemplates as returned for example by http://developer.github.com/v3/todo + This class represents GitignoreTemplates. The reference can be found here https://developer.github.com/v3/gitignore/ """ def __repr__(self): diff --git a/github/Hook.py b/github/Hook.py index ce3a70d6..bd788959 100644 --- a/github/Hook.py +++ b/github/Hook.py @@ -32,7 +32,7 @@ import github.HookResponse class Hook(github.GithubObject.CompletableGithubObject): """ - This class represents Hooks as returned for example by http://developer.github.com/v3/repos/hooks + This class represents Hooks. The reference can be found here http://developer.github.com/v3/repos/hooks """ def __repr__(self): diff --git a/github/HookDescription.py b/github/HookDescription.py index d1058307..bb9926b7 100644 --- a/github/HookDescription.py +++ b/github/HookDescription.py @@ -30,7 +30,7 @@ import github.GithubObject class HookDescription(github.GithubObject.NonCompletableGithubObject): """ - This class represents HookDescriptions as returned for example by http://developer.github.com/v3/todo + This class represents HookDescriptions """ def __repr__(self): diff --git a/github/HookResponse.py b/github/HookResponse.py index bce05e39..ef960eba 100644 --- a/github/HookResponse.py +++ b/github/HookResponse.py @@ -30,7 +30,7 @@ import github.GithubObject class HookResponse(github.GithubObject.NonCompletableGithubObject): """ - This class represents HookResponses as returned for example by http://developer.github.com/v3/todo + This class represents HookResponses """ def __repr__(self): diff --git a/github/InputFileContent.py b/github/InputFileContent.py index a133eb1e..62ae4e2b 100644 --- a/github/InputFileContent.py +++ b/github/InputFileContent.py @@ -29,6 +29,7 @@ import github.GithubObject class InputFileContent(object): """ + This class represents InputFileContents """ def __init__(self, content, new_name=github.GithubObject.NotSet): diff --git a/github/InputGitAuthor.py b/github/InputGitAuthor.py index f7a9ff14..3e35880f 100644 --- a/github/InputGitAuthor.py +++ b/github/InputGitAuthor.py @@ -29,6 +29,7 @@ import github.GithubObject class InputGitAuthor(object): """ + This class represents InputGitAuthors """ def __init__(self, name, email, date=github.GithubObject.NotSet): diff --git a/github/InputGitTreeElement.py b/github/InputGitTreeElement.py index ee55452c..f505331e 100644 --- a/github/InputGitTreeElement.py +++ b/github/InputGitTreeElement.py @@ -29,6 +29,7 @@ import github.GithubObject class InputGitTreeElement(object): """ + This class represents InputGitTreeElements """ def __init__(self, path, mode, type, content=github.GithubObject.NotSet, sha=github.GithubObject.NotSet): diff --git a/github/Installation.py b/github/Installation.py index 94f4828b..fc0bad81 100644 --- a/github/Installation.py +++ b/github/Installation.py @@ -41,7 +41,7 @@ INTEGRATION_PREVIEW_HEADERS = {"Accept": "application/vnd.github.machine-man-pre class Installation(github.GithubObject.NonCompletableGithubObject): """ - This class represents Installations as in https://developer.github.com/v3/integrations/installations + This class represents Installations. The reference can be found here https://developer.github.com/v3/apps/installations/ """ def __repr__(self): diff --git a/github/InstallationAuthorization.py b/github/InstallationAuthorization.py index f4f741ba..03391226 100644 --- a/github/InstallationAuthorization.py +++ b/github/InstallationAuthorization.py @@ -31,7 +31,7 @@ import github.NamedUser class InstallationAuthorization(github.GithubObject.NonCompletableGithubObject): """ - InstallationAuthorization as obtained from a GitHub integration. + This class represents InstallationAuthorizations """ def __repr__(self): diff --git a/github/Issue.py b/github/Issue.py index a0fd97ba..c49f792c 100644 --- a/github/Issue.py +++ b/github/Issue.py @@ -45,7 +45,7 @@ import github.Reaction class Issue(github.GithubObject.CompletableGithubObject): """ - This class represents Issues as returned for example by http://developer.github.com/v3/todo + This class represents Issues. The reference can be found here https://developer.github.com/v3/issues/ """ def __repr__(self): diff --git a/github/IssueComment.py b/github/IssueComment.py index 73bb4b45..e19b569f 100644 --- a/github/IssueComment.py +++ b/github/IssueComment.py @@ -33,7 +33,7 @@ import github.NamedUser class IssueComment(github.GithubObject.CompletableGithubObject): """ - This class represents IssueComments as returned for example by http://developer.github.com/v3/todo + This class represents IssueComments. The reference can be found here https://developer.github.com/v3/issues/comments/ """ def __repr__(self): diff --git a/github/IssueEvent.py b/github/IssueEvent.py index 362a6bb9..b6e6700e 100644 --- a/github/IssueEvent.py +++ b/github/IssueEvent.py @@ -33,7 +33,7 @@ import github.NamedUser class IssueEvent(github.GithubObject.CompletableGithubObject): """ - This class represents IssueEvents as returned for example by http://developer.github.com/v3/todo + This class represents IssueEvents. The reference can be found here https://developer.github.com/v3/issues/events/ """ def __repr__(self): diff --git a/github/IssuePullRequest.py b/github/IssuePullRequest.py index 18243d11..7526a11f 100644 --- a/github/IssuePullRequest.py +++ b/github/IssuePullRequest.py @@ -30,7 +30,7 @@ import github.GithubObject class IssuePullRequest(github.GithubObject.NonCompletableGithubObject): """ - This class represents IssuePullRequests as returned for example by http://developer.github.com/v3/todo + This class represents IssuePullRequests """ @property diff --git a/github/MainClass.py b/github/MainClass.py index ee3e0258..19b5eb6d 100644 --- a/github/MainClass.py +++ b/github/MainClass.py @@ -61,7 +61,7 @@ DEFAULT_PER_PAGE = 30 class Github(object): """ - This is the main class you instanciate to access the Github API v3. Optional parameters allow different authentication methods. + This is the main class you instantiate to access the Github API v3. Optional parameters allow different authentication methods. """ def __init__(self, login_or_token=None, password=None, base_url=DEFAULT_BASE_URL, timeout=DEFAULT_TIMEOUT, client_id=None, client_secret=None, user_agent='PyGithub/Python', per_page=DEFAULT_PER_PAGE, api_preview=False): diff --git a/github/NamedUser.py b/github/NamedUser.py index 93e6e5ae..bc737975 100644 --- a/github/NamedUser.py +++ b/github/NamedUser.py @@ -40,7 +40,7 @@ import github.Event class NamedUser(github.GithubObject.CompletableGithubObject): """ - This class represents NamedUsers as returned for example by http://developer.github.com/v3/todo + This class represents NamedUsers. The reference can be found here https://developer.github.com/v3/users/#get-a-single-user """ def __repr__(self): diff --git a/github/NotificationSubject.py b/github/NotificationSubject.py index c4289424..b7ae874f 100644 --- a/github/NotificationSubject.py +++ b/github/NotificationSubject.py @@ -28,7 +28,7 @@ import github.GithubObject class NotificationSubject(github.GithubObject.NonCompletableGithubObject): """ - This class represents Subjects of Notifications as returned for example by http://developer.github.com/v3/activity/notifications/#list-your-notifications + This class represents Subjects of Notifications. The reference can be found here http://developer.github.com/v3/activity/notifications/#list-your-notifications """ def __repr__(self): diff --git a/github/Permissions.py b/github/Permissions.py index 3bb6faf8..dc5de33f 100644 --- a/github/Permissions.py +++ b/github/Permissions.py @@ -30,7 +30,7 @@ import github.GithubObject class Permissions(github.GithubObject.NonCompletableGithubObject): """ - This class represents Permissionss as returned for example by http://developer.github.com/v3/todo + This class represents Permissions """ def __repr__(self): diff --git a/github/Plan.py b/github/Plan.py index 0b6473ae..66e0ecb5 100644 --- a/github/Plan.py +++ b/github/Plan.py @@ -30,7 +30,7 @@ import github.GithubObject class Plan(github.GithubObject.NonCompletableGithubObject): """ - This class represents Plans as returned for example by http://developer.github.com/v3/todo + This class represents Plans """ def __repr__(self): diff --git a/github/PullRequestMergeStatus.py b/github/PullRequestMergeStatus.py index a59adfa9..8ea1e6c1 100644 --- a/github/PullRequestMergeStatus.py +++ b/github/PullRequestMergeStatus.py @@ -31,7 +31,7 @@ import github.GithubObject class PullRequestMergeStatus(github.GithubObject.NonCompletableGithubObject): """ - This class represents PullRequestMergeStatuss. The reference can be found here http://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged + This class represents PullRequestMergeStatuses. The reference can be found here http://developer.github.com/v3/pulls/#get-if-a-pull-request-has-been-merged """ def __repr__(self): diff --git a/github/PullRequestPart.py b/github/PullRequestPart.py index 8f03d6f1..9d9278b6 100644 --- a/github/PullRequestPart.py +++ b/github/PullRequestPart.py @@ -33,7 +33,7 @@ import github.NamedUser class PullRequestPart(github.GithubObject.NonCompletableGithubObject): """ - This class represents PullRequestParts as returned for example by http://developer.github.com/v3/todo + This class represents PullRequestParts """ def __repr__(self): diff --git a/github/PullRequestReview.py b/github/PullRequestReview.py index 944200c0..560447ad 100644 --- a/github/PullRequestReview.py +++ b/github/PullRequestReview.py @@ -33,7 +33,7 @@ import github.NamedUser class PullRequestReview(github.GithubObject.CompletableGithubObject): """ - This class represents Pull Request Reviews as returned for example by https://developer.github.com/v3/pulls/reviews/ + This class represents PullRequestReviews. The reference can be found here https://developer.github.com/v3/pulls/reviews/ """ def __repr__(self): diff --git a/github/PullRequestReviewerRequest.py b/github/PullRequestReviewerRequest.py index 6f3ea688..6f0ef716 100644 --- a/github/PullRequestReviewerRequest.py +++ b/github/PullRequestReviewerRequest.py @@ -33,7 +33,7 @@ import github.NamedUser class PullRequestReviewerRequest(github.GithubObject.CompletableGithubObject): """ - This class represents Pull Request Reviewer Requests as returned for example by https://developer.github.com/v3/pulls/review_requests/ + This class represents PullRequestReviewerRequests. The reference can be found here https://developer.github.com/v3/pulls/review_requests/ """ def __repr__(self): diff --git a/github/Rate.py b/github/Rate.py index 5c7e4f5d..d743dee3 100644 --- a/github/Rate.py +++ b/github/Rate.py @@ -28,7 +28,7 @@ import datetime class Rate(github.GithubObject.NonCompletableGithubObject): """ - This class represents rate limits as defined in http://developer.github.com/v3/rate_limit + This class represents Rates. The reference can be found here http://developer.github.com/v3/rate_limit """ def __repr__(self): diff --git a/github/RateLimit.py b/github/RateLimit.py index 9ff0f08c..7d3a34a2 100644 --- a/github/RateLimit.py +++ b/github/RateLimit.py @@ -28,7 +28,7 @@ import github.Rate class RateLimit(github.GithubObject.NonCompletableGithubObject): """ - This class represents rate limits as defined in http://developer.github.com/v3/rate_limit + This class represents RateLimits. The reference can be found here http://developer.github.com/v3/rate_limit """ def __repr__(self): diff --git a/github/Reaction.py b/github/Reaction.py index 9a609297..f11b6364 100644 --- a/github/Reaction.py +++ b/github/Reaction.py @@ -33,7 +33,7 @@ import github.NamedUser class Reaction(github.GithubObject.CompletableGithubObject): """ - This class represents Reaction + This class represents Reactions. The reference can be found here https://developer.github.com/v3/reactions/ """ def __repr__(self): diff --git a/github/Repository.py b/github/Repository.py index a5f0f3f5..a888b551 100644 --- a/github/Repository.py +++ b/github/Repository.py @@ -2123,7 +2123,7 @@ class Repository(github.GithubObject.CompletableGithubObject): def get_releases(self): """ :calls: `GET /repos/:owner/:repo/releases `_ - :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.Tag.Tag` + :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.GitRelease.GitRelease` """ return github.PaginatedList.PaginatedList( github.GitRelease.GitRelease, diff --git a/github/Stargazer.py b/github/Stargazer.py index 6fca6a29..bf1c83ae 100644 --- a/github/Stargazer.py +++ b/github/Stargazer.py @@ -36,8 +36,7 @@ import github class Stargazer(github.GithubObject.NonCompletableGithubObject): """ - This class represents Stargazers with the date of starring as returned by - https://developer.github.com/v3/activity/starring/#alternative-response-with-star-creation-timestamps + This class represents Stargazers. The reference can be found here https://developer.github.com/v3/activity/starring/#alternative-response-with-star-creation-timestamps """ def __repr__(self): diff --git a/github/StatsCodeFrequency.py b/github/StatsCodeFrequency.py index 0635c072..7f8dd773 100755 --- a/github/StatsCodeFrequency.py +++ b/github/StatsCodeFrequency.py @@ -27,7 +27,7 @@ import github.GithubObject class StatsCodeFrequency(github.GithubObject.NonCompletableGithubObject): """ - This class represents statistics of code frequency. The reference can be found here http://developer.github.com/v3/repos/statistics/#get-the-number-of-additions-and-deletions-per-week + This class represents statistics of StatsCodeFrequencies. The reference can be found here http://developer.github.com/v3/repos/statistics/#get-the-number-of-additions-and-deletions-per-week """ @property diff --git a/github/StatsCommitActivity.py b/github/StatsCommitActivity.py index ded0b93c..6138931f 100755 --- a/github/StatsCommitActivity.py +++ b/github/StatsCommitActivity.py @@ -27,7 +27,7 @@ import github.GithubObject class StatsCommitActivity(github.GithubObject.NonCompletableGithubObject): """ - This class represents statistics of commit activity. The reference can be found here http://developer.github.com/v3/repos/statistics/#get-the-last-year-of-commit-activity-data + This class represents StatsCommitActivities. The reference can be found here http://developer.github.com/v3/repos/statistics/#get-the-last-year-of-commit-activity-data """ @property diff --git a/github/StatsContributor.py b/github/StatsContributor.py index fda45b03..5155274d 100755 --- a/github/StatsContributor.py +++ b/github/StatsContributor.py @@ -29,7 +29,7 @@ import github.NamedUser class StatsContributor(github.GithubObject.NonCompletableGithubObject): """ - This class represents statistics of a contibutor. The reference can be found here http://developer.github.com/v3/repos/statistics/#get-contributors-list-with-additions-deletions-and-commit-counts + This class represents StatsContributors. The reference can be found here http://developer.github.com/v3/repos/statistics/#get-contributors-list-with-additions-deletions-and-commit-counts """ class Week(github.GithubObject.NonCompletableGithubObject): diff --git a/github/StatsParticipation.py b/github/StatsParticipation.py index b4acd449..4ac63ab5 100755 --- a/github/StatsParticipation.py +++ b/github/StatsParticipation.py @@ -29,7 +29,7 @@ import github.NamedUser class StatsParticipation(github.GithubObject.NonCompletableGithubObject): """ - This class represents statistics of participation. The reference can be found here http://developer.github.com/v3/repos/statistics/#get-the-weekly-commit-count-for-the-repo-owner-and-everyone-else + This class represents StatsParticipations. The reference can be found here http://developer.github.com/v3/repos/statistics/#get-the-weekly-commit-count-for-the-repo-owner-and-everyone-else """ @property diff --git a/github/StatsPunchCard.py b/github/StatsPunchCard.py index 733d4a81..67ef45b0 100755 --- a/github/StatsPunchCard.py +++ b/github/StatsPunchCard.py @@ -29,7 +29,7 @@ import github.NamedUser class StatsPunchCard(github.GithubObject.NonCompletableGithubObject): """ - This class represents the punch card. The reference can be found here http://developer.github.com/v3/repos/statistics/#get-the-number-of-commits-per-hour-in-each-day + This class represents StatsPunchCards. The reference can be found here http://developer.github.com/v3/repos/statistics/#get-the-number-of-commits-per-hour-in-each-day """ def get(self, day, hour): diff --git a/github/Status.py b/github/Status.py index 67a6b804..98ea5952 100644 --- a/github/Status.py +++ b/github/Status.py @@ -27,7 +27,7 @@ import github.GithubObject class Status(github.GithubObject.NonCompletableGithubObject): """ - This class represents status as defined in https://status.github.com/api + This class represents Statuses. The reference can be found here https://status.github.com/api """ def __repr__(self): diff --git a/github/StatusMessage.py b/github/StatusMessage.py index ec081e39..ede37e5d 100644 --- a/github/StatusMessage.py +++ b/github/StatusMessage.py @@ -27,7 +27,7 @@ import github.GithubObject class StatusMessage(github.GithubObject.NonCompletableGithubObject): """ - This class represents status messages as defined in https://status.github.com/api + This class represents StatusMessages. The reference can be found here https://status.github.com/api """ def __repr__(self): diff --git a/github/Tag.py b/github/Tag.py index c837c74e..8149c3a3 100644 --- a/github/Tag.py +++ b/github/Tag.py @@ -33,7 +33,7 @@ import github.Commit class Tag(github.GithubObject.NonCompletableGithubObject): """ - This class represents Tags. The reference can be found here http://developer.github.com/v3/git/tags/ + This class represents Tags. The reference can be found here https://developer.github.com/v3/repos/#list-tags """ def __repr__(self):