Skip to content

Commit db71d80

Browse files
committed
Clarify get_review_comments description
1 parent 2b8d02a commit db71d80

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -836,7 +836,7 @@ Possible options:
836836
2. get_diff - Get the diff of a pull request.
837837
3. get_status - Get status of a head commit in a pull request. This reflects status of builds and checks.
838838
4. get_files - Get the list of files changed in a pull request. Use with pagination parameters to control the number of results returned.
839-
5. get_review_comments - Get the review comments on a pull request. Use with pagination parameters to control the number of results returned.
839+
5. get_review_comments - Get the review comments on a pull request. They are comments made on a portion of the unified diff during a pull request review. These are different from commit comments and issue comments in a pull request. Use with pagination parameters to control the number of results returned.
840840
6. get_reviews - Get the reviews on a pull request. When asked for review comments, use get_review_comments method.
841841
(string, required)
842842
- `owner`: Repository owner (string, required)

pkg/github/pullrequests.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ Possible options:
3333
2. get_diff - Get the diff of a pull request.
3434
3. get_status - Get status of a head commit in a pull request. This reflects status of builds and checks.
3535
4. get_files - Get the list of files changed in a pull request. Use with pagination parameters to control the number of results returned.
36-
5. get_review_comments - Get the review comments on a pull request. Use with pagination parameters to control the number of results returned.
36+
5. get_review_comments - Get the review comments on a pull request. They are comments made on a portion of the unified diff during a pull request review. These are different from commit comments and issue comments in a pull request. Use with pagination parameters to control the number of results returned.
3737
6. get_reviews - Get the reviews on a pull request. When asked for review comments, use get_review_comments method.
3838
`),
3939

0 commit comments

Comments
 (0)