Add sort order and direction for getting comments (#2544)

Note: This is a breaking change. The order of parameters of `PullRequest.get_review_comments` has changed to match other `get_comments` methods and Github API parameter order. Users should change `PullRequest.get_review_comments(since)` to `PullRequest.get_review_comments(since=since)`.

Calling without parameter is not breaking: `PullRequest.get_review_comments()`
This commit is contained in:
Enrico Minack
2023-06-07 14:50:07 +02:00
committed by GitHub
parent 217d424187
commit a8e7c4237d
25 changed files with 184 additions and 185 deletions
+2 -2
View File
@@ -2957,8 +2957,8 @@ class Repository(github.GithubObject.CompletableGithubObject):
):
"""
:calls: `GET /repos/{owner}/{repo}/pulls/comments <https://docs.github.com/en/rest/reference/pulls#review-comments>`_
:param sort: string
:param direction: string
:param sort: string 'created', 'updated', 'created_at'
:param direction: string 'asc' or 'desc'
:param since: datetime.datetime
:rtype: :class:`github.PaginatedList.PaginatedList` of :class:`github.PullRequestComment.PullRequestComment`
"""