Fix broken Github reference link in class docstrings

This commit is contained in:
Wan Liuyang
2018-03-13 15:07:07 +08:00
parent c7f6563c34
commit a32a17bf81
62 changed files with 61 additions and 69 deletions
+1 -1
View File
@@ -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.
"""
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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
-7
View File
@@ -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) #
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -4
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1
View File
@@ -29,6 +29,7 @@ import github.GithubObject
class InputFileContent(object):
"""
This class represents InputFileContents
"""
def __init__(self, content, new_name=github.GithubObject.NotSet):
+1
View File
@@ -29,6 +29,7 @@ import github.GithubObject
class InputGitAuthor(object):
"""
This class represents InputGitAuthors
"""
def __init__(self, name, email, date=github.GithubObject.NotSet):
+1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -2123,7 +2123,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_releases(self):
"""
:calls: `GET /repos/:owner/:repo/releases <http://developer.github.com/v3/repos>`_
: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,
+1 -2
View File
@@ -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):
+1 -1
View File
@@ -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
+1 -1
View File
@@ -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
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):
+1 -1
View File
@@ -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):