diff --git a/github/CommitComment.py b/github/CommitComment.py index 9399d684..e33b42db 100644 --- a/github/CommitComment.py +++ b/github/CommitComment.py @@ -162,7 +162,7 @@ class CommitComment(github.GithubObject.CompletableGithubObject): def get_reactions(self): """ :calls: `GET /repos/:owner/:repo/comments/:id/reactions - ` + `_ :return: :class: :class:`github.PaginatedList.PaginatedList` of :class:`github.Reaction.Reaction` """ return github.PaginatedList.PaginatedList( diff --git a/github/Issue.py b/github/Issue.py index 434b3f4c..c1c15a61 100644 --- a/github/Issue.py +++ b/github/Issue.py @@ -454,7 +454,7 @@ class Issue(github.GithubObject.CompletableGithubObject): def get_reactions(self): """ - :calls: `GET /repos/:owner/:repo/issues/:number/reactions ` + :calls: `GET /repos/:owner/:repo/issues/:number/reactions `_ :return: :class: :class:`github.PaginatedList.PaginatedList` of :class:`github.Reaction.Reaction` """ return github.PaginatedList.PaginatedList( diff --git a/github/IssueComment.py b/github/IssueComment.py index fd7b9f4a..f2c8f14e 100644 --- a/github/IssueComment.py +++ b/github/IssueComment.py @@ -139,7 +139,7 @@ class IssueComment(github.GithubObject.CompletableGithubObject): def get_reactions(self): """ :calls: `GET /repos/:owner/:repo/issues/comments/:id/reactions - ` + `_ :return: :class: :class:`github.PaginatedList.PaginatedList` of :class:`github.Reaction.Reaction` """ return github.PaginatedList.PaginatedList( diff --git a/github/PullRequest.py b/github/PullRequest.py index b2aff687..f7978ae0 100644 --- a/github/PullRequest.py +++ b/github/PullRequest.py @@ -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 `_ + :calls: `POST /repos/:owner/:repo/pulls/:number/requested_reviewers `_ :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 `_ + :calls: `DELETE /repos/:owner/:repo/pulls/:number/requested_reviewers `_ :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 `_ :rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.PullRequestComment.PullRequestComment` """ diff --git a/github/PullRequestComment.py b/github/PullRequestComment.py index dfb890a4..5cc66f78 100644 --- a/github/PullRequestComment.py +++ b/github/PullRequestComment.py @@ -195,7 +195,7 @@ class PullRequestComment(github.GithubObject.CompletableGithubObject): def get_reactions(self): """ :calls: `GET /repos/:owner/:repo/pulls/comments/:number/reactions - ` + `_ :return: :class: :class:`github.PaginatedList.PaginatedList` of :class:`github.Reaction.Reaction` """ return github.PaginatedList.PaginatedList( diff --git a/github/Repository.py b/github/Repository.py index a046ba54..55ae5862 100644 --- a/github/Repository.py +++ b/github/Repository.py @@ -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 `_ :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 `_ :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 `_ :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 `_ :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 `_ :param id: int (release id), str (tag name) :rtype: None or :class:`github.GitRelease.GitRelease` """