status-im/PyGithub
1
0
Fork 0
mirror of https://github.com/status-im/PyGithub.git synced 2026-09-01 19:31:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix incorrect formatting in docstrings (#816)

Browse Source
This commit is contained in:
per1234
2018-06-11 22:24:27 +08:00
committed by Wan Liuyang
parent 2bd06255fe
commit bed4009361
6 changed files with 13 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
github/CommitComment.py
+1 -1
View File
@@ -162,7 +162,7 @@ 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>`
<https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment>`_
:return: :class: :class:`github.PaginatedList.PaginatedList` of :class:`github.Reaction.Reaction`
"""
return github.PaginatedList.PaginatedList(
github/Issue.py
+1 -1
View File
@@ -454,7 +454,7 @@ class Issue(github.GithubObject.CompletableGithubObject):
def get_reactions(self):
"""
:calls: `GET /repos/:owner/:repo/issues/:number/reactions <https://developer.github.com/v3/reactions/#list-reactions-for-an-issue>`
:calls: `GET /repos/:owner/:repo/issues/:number/reactions <https://developer.github.com/v3/reactions/#list-reactions-for-an-issue>`_
:return: :class: :class:`github.PaginatedList.PaginatedList` of :class:`github.Reaction.Reaction`
"""
return github.PaginatedList.PaginatedList(
github/IssueComment.py
+1 -1
View File
@@ -139,7 +139,7 @@ class IssueComment(github.GithubObject.CompletableGithubObject):
def get_reactions(self):
"""
:calls: `GET /repos/:owner/:repo/issues/comments/:id/reactions
<https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment>`
<https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment>`_
:return: :class: :class:`github.PaginatedList.PaginatedList` of :class:`github.Reaction.Reaction`
"""
return github.PaginatedList.PaginatedList(
github/PullRequest.py
+3 -2
View File
@@ -439,7 +439,7 @@ class PullRequest(github.GithubObject.CompletableGithubObject):
def create_review_request(self, reviewers=github.GithubObject.NotSet, team_reviewers=github.GithubObject.NotSet):
"""
:calls `POST /repos/:owner/:repo/pulls/:number/requested_reviewers <https://developer.github.com/v3/pulls/review_requests/>`_
:calls: `POST /repos/:owner/:repo/pulls/:number/requested_reviewers <https://developer.github.com/v3/pulls/review_requests/>`_
:param reviewers: list of strings
:param team_reviewers: list of strings
:rtype: None
@@ -459,7 +459,7 @@ class PullRequest(github.GithubObject.CompletableGithubObject):
def delete_review_request(self, reviewers=github.GithubObject.NotSet, team_reviewers=github.GithubObject.NotSet):
"""
:calls `DELETE /repos/:owner/:repo/pulls/:number/requested_reviewers <https://developer.github.com/v3/pulls/review_requests/>`_
:calls: `DELETE /repos/:owner/:repo/pulls/:number/requested_reviewers <https://developer.github.com/v3/pulls/review_requests/>`_
:param reviewers: list of strings
:param team_reviewers: list of strings
:rtype: None
@@ -530,6 +530,7 @@ class PullRequest(github.GithubObject.CompletableGithubObject):
def get_comments(self):
"""
Warning: this only returns review comments. For normal conversation comments, use get_issue_comments.
:calls: `GET /repos/:owner/:repo/pulls/:number/comments <http://developer.github.com/v3/pulls/comments>`_
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.PullRequestComment.PullRequestComment`
"""
github/PullRequestComment.py
+1 -1
View File
@@ -195,7 +195,7 @@ 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>`
<https://developer.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment>`_
:return: :class: :class:`github.PaginatedList.PaginatedList` of :class:`github.Reaction.Reaction`
"""
return github.PaginatedList.PaginatedList(
github/Repository.py
+6 -3
View File
@@ -1110,7 +1110,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def create_source_import(self, vcs, vcs_url, vcs_username=github.GithubObject.NotSet, vcs_password=github.GithubObject.NotSet):
"""
:calls: `PUT /repos/:owner/:repo/import https://developer.github.com/v3/migration/source_imports/#start-an-import`_
:calls: `PUT /repos/:owner/:repo/import <https://developer.github.com/v3/migration/source_imports/#start-an-import>`_
:param vcs: string
:param vcs_url: string
:param vcs_username: string
@@ -1392,6 +1392,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
committer=github.GithubObject.NotSet,
author=github.GithubObject.NotSet):
"""Create a file in this repository.
:calls: `PUT /repos/:owner/:repo/contents/:path <http://developer.github.com/v3/repos/contents#create-a-file>`_
:param path: string, (required), path of the file in the repository
:param message: string, (required), commit message
@@ -1450,6 +1451,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
committer=github.GithubObject.NotSet,
author=github.GithubObject.NotSet):
"""This method updates a file in a repository
:calls: `PUT /repos/:owner/:repo/contents/:path <http://developer.github.com/v3/repos/contents#update-a-file>`_
:param path: string, Required. The content path.
:param message: string, Required. The commit message.
@@ -1512,7 +1514,8 @@ class Repository(github.GithubObject.CompletableGithubObject):
branch=github.GithubObject.NotSet,
committer=github.GithubObject.NotSet,
author=github.GithubObject.NotSet):
"""This method delete a file in a repository
"""This method deletes a file in a repository
:calls: `DELETE /repos/:owner/:repo/contents/:path <https://developer.github.com/v3/repos/contents/#delete-a-file>`_
:param path: string, Required. The content path.
:param message: string, Required. The commit message.
@@ -2261,7 +2264,7 @@ class Repository(github.GithubObject.CompletableGithubObject):
def get_release(self, id):
"""
:calls: `GET /repos/:owner/:repo/releases/:id https://developer.github.com/v3/repos/releases/#get-a-single-release
:calls: `GET /repos/:owner/:repo/releases/:id <https://developer.github.com/v3/repos/releases/#get-a-single-release>`_
:param id: int (release id), str (tag name)
:rtype: None or :class:`github.GitRelease.GitRelease`
"""