You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* I interpreted it as if the example was showing how to make a commit comment on a commit in the PR. This makes it clearer that its a review comment on the unified diff.
Copy file name to clipboardExpand all lines: content/v3/pulls/comments.md
+3-1Lines changed: 3 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -62,10 +62,12 @@ Name | Type | Description
62
62
Name | Type | Description
63
63
-----|------|--------------
64
64
`body`|`string` | **Required**. The text of the comment
65
-
`commit_id`|`string` | **Required**. The SHA of the commit to comment on.
65
+
`commit_id`|`string` | **Required**. The SHA of the latest commit of the pull request to comment on.
66
66
`path`|`string` | **Required**. The relative path of the file to comment on.
67
67
`position`|`integer` | **Required**. The line index in the diff to comment on.
68
68
69
+
Note: When passing the `commit_id`, use the SHA of the latest commit in the pull request or your comment may appear as "outdated" if the specified `position` has been modified in a subsequent commit.
0 commit comments