From 59502dc6b158165238f3a547fd860f8950891706 Mon Sep 17 00:00:00 2001 From: Miquel Puig Turon Date: Sun, 6 Apr 2025 11:56:24 +0200 Subject: [PATCH] Clarify create_pull_request_review definition for input: 'position' --- pkg/github/pullrequests.go | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/pkg/github/pullrequests.go b/pkg/github/pullrequests.go index c02336ca..78601ce1 100644 --- a/pkg/github/pullrequests.go +++ b/pkg/github/pullrequests.go @@ -600,8 +600,9 @@ func createPullRequestReview(client *github.Client, t translations.TranslationHe "description": "path to the file", }, "position": map[string]interface{}{ - "type": "number", - "description": "line number in the file", + "type": "number", + "description": `number of lines down from the first "@@" hunk header in the diff. The line just below the "@@" line is position 1, the next line is position 2, and so on. The position in the diff continues to increase through lines of whitespace and additional hunks. + This value is not the same as the line number in the file.`, }, "body": map[string]interface{}{ "type": "string",