Update most URLs to docs.github.com (#1896)

Now that GitHub have moved their documentation from
developer.github.com, we should update our links. I have also tried to
update the call strings to their new format, but since it was done via
regex, some of them may not match exactly.
This commit is contained in:
Steve Kowalik
2021-03-26 20:43:48 +11:00
committed by GitHub
parent ad124ef481
commit babcbcd04f
80 changed files with 529 additions and 530 deletions
+9 -9
View File
@@ -41,7 +41,7 @@ from . import Consts
class PullRequestComment(github.GithubObject.CompletableGithubObject):
"""
This class represents PullRequestComments. The reference can be found here http://developer.github.com/v3/pulls/comments/
This class represents PullRequestComments. The reference can be found here http://docs.github.com/en/rest/reference/pulls#comments
"""
def __repr__(self):
@@ -169,14 +169,14 @@ class PullRequestComment(github.GithubObject.CompletableGithubObject):
def delete(self):
"""
:calls: `DELETE /repos/:owner/:repo/pulls/comments/:number <http://developer.github.com/v3/pulls/comments>`_
:calls: `DELETE /repos/{owner}/{repo}/pulls/comments/{number} <http://docs.github.com/en/rest/reference/pulls#comments>`_
:rtype: None
"""
headers, data = self._requester.requestJsonAndCheck("DELETE", self.url)
def edit(self, body):
"""
:calls: `PATCH /repos/:owner/:repo/pulls/comments/:number <http://developer.github.com/v3/pulls/comments>`_
:calls: `PATCH /repos/{owner}/{repo}/pulls/comments/{number} <http://docs.github.com/en/rest/reference/pulls#comments>`_
:param body: string
:rtype: None
"""
@@ -191,8 +191,8 @@ class PullRequestComment(github.GithubObject.CompletableGithubObject):
def get_reactions(self):
"""
:calls: `GET /repos/:owner/:repo/pulls/comments/:number/reactions
<https://developer.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment>`_
:calls: `GET /repos/{owner}/{repo}/pulls/comments/{number}/reactions
<https://docs.github.com/en/rest/reference/reactions#list-reactions-for-a-pull-request-review-comment>`_
:return: :class: :class:`github.PaginatedList.PaginatedList` of :class:`github.Reaction.Reaction`
"""
return github.PaginatedList.PaginatedList(
@@ -205,8 +205,8 @@ class PullRequestComment(github.GithubObject.CompletableGithubObject):
def create_reaction(self, reaction_type):
"""
:calls: `POST /repos/:owner/:repo/pulls/comments/:number/reactions
<https://developer.github.com/v3/reactions/#create-reaction-for-a-pull-request-review-comment>`_
:calls: `POST /repos/{owner}/{repo}/pulls/comments/{number}/reactions
<https://docs.github.com/en/rest/reference/reactions#create-reaction-for-a-pull-request-review-comment>`_
:param reaction_type: string
:rtype: :class:`github.Reaction.Reaction`
"""
@@ -224,8 +224,8 @@ class PullRequestComment(github.GithubObject.CompletableGithubObject):
def delete_reaction(self, reaction_id):
"""
:calls: `DELETE /repos/:owner/:repo/pulls/comments/:comment_id/reactions/:reaction_id
<https://developer.github.com/v3/reactions/#delete-a-pull-request-comment-reaction>`_
:calls: `DELETE /repos/{owner}/{repo}/pulls/comments/{comment_id}/reactions/{reaction_id}
<https://docs.github.com/en/rest/reference/reactions#delete-a-pull-request-comment-reaction>`_
:param reaction_id: integer
:rtype: bool
"""