status-im/PyGithub
1
0
Fork 0
mirror of https://github.com/status-im/PyGithub.git synced 2026-09-02 03:41:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
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
Download Patch File Download Diff File Expand all files Collapse all files
github/CommitComment.py
+9 -9
View File
@@ -39,7 +39,7 @@ from . import Consts
class CommitComment(github.GithubObject.CompletableGithubObject):
"""
This class represents CommitComments. The reference can be found here https://developer.github.com/v3/repos/comments/
This class represents CommitComments. The reference can be found here https://docs.github.com/en/rest/reference/repos#comments
"""
def __repr__(self):
@@ -135,14 +135,14 @@ class CommitComment(github.GithubObject.CompletableGithubObject):
def delete(self):
"""
:calls: `DELETE /repos/:owner/:repo/comments/:id <http://developer.github.com/v3/repos/comments>`_
:calls: `DELETE /repos/{owner}/{repo}/comments/{id} <http://docs.github.com/en/rest/reference/repos#comments>`_
:rtype: None
"""
headers, data = self._requester.requestJsonAndCheck("DELETE", self.url)
def edit(self, body):
"""
:calls: `PATCH /repos/:owner/:repo/comments/:id <http://developer.github.com/v3/repos/comments>`_
:calls: `PATCH /repos/{owner}/{repo}/comments/{id} <http://docs.github.com/en/rest/reference/repos#comments>`_
:param body: string
:rtype: None
"""
@@ -157,8 +157,8 @@ class CommitComment(github.GithubObject.CompletableGithubObject):
def get_reactions(self):
"""
:calls: `GET /repos/:owner/:repo/comments/:id/reactions
<https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment>`_
:calls: `GET /repos/{owner}/{repo}/comments/{id}/reactions
<https://docs.github.com/en/rest/reference/reactions#list-reactions-for-a-commit-comment>`_
:return: :class: :class:`github.PaginatedList.PaginatedList` of :class:`github.Reaction.Reaction`
"""
return github.PaginatedList.PaginatedList(
@@ -171,8 +171,8 @@ class CommitComment(github.GithubObject.CompletableGithubObject):
def create_reaction(self, reaction_type):
"""
:calls: `POST /repos/:owner/:repo/comments/:id/reactions
<https://developer.github.com/v3/reactions/#create-reaction-for-a-commit-comment>`_
:calls: `POST /repos/{owner}/{repo}/comments/{id}/reactions
<https://docs.github.com/en/rest/reference/reactions#create-reaction-for-a-commit-comment>`_
:param reaction_type: string
:rtype: :class:`github.Reaction.Reaction`
"""
@@ -190,8 +190,8 @@ class CommitComment(github.GithubObject.CompletableGithubObject):
def delete_reaction(self, reaction_id):
"""
:calls: `DELETE /repos/:owner/:repo/comments/:comment_id/reactions/:reaction_id
<https://developer.github.com/v3/reactions/#delete-a-commit-comment-reaction>`_
:calls: `DELETE /repos/{owner}/{repo}/comments/{comment_id}/reactions/{reaction_id}
<https://docs.github.com/en/rest/reference/reactions#delete-a-commit-comment-reaction>`_
:param reaction_id: integer
:rtype: bool
"""