Skip to content
This repository was archived by the owner on Mar 6, 2024. It is now read-only.

Commit 3bc4ba3

Browse files
authored
fix instructions (#171)
1 parent 80dbff0 commit 3bc4ba3

File tree

1 file changed

+13
-11
lines changed

1 file changed

+13
-11
lines changed

src/review.ts

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -485,11 +485,11 @@ ${comment_chain}
485485
// add instructions
486486
ins.patches += `
487487
Instructions for you:
488-
- Only respond in the below response format and nothing else. Each review
489-
section must consist of a line number range and a comment for
490-
that line number range. Optionally, you can include replacement suggestion
491-
or new code snippets in the review comment. There's a separator between
492-
review sections.
488+
- Only respond in the below response format consisting of multiple review
489+
sections and nothing else. Each review section must consist of a line
490+
number range and a comment for that line number range. Optionally,
491+
you can include replacement suggestion or new code snippets in the
492+
review comment. There's a separator between review sections.
493493
- It's important that line number ranges for each review section must
494494
be within the line number range of a specific new hunk. i.e.
495495
<start_line_number> must belong to the same hunk as the
@@ -500,13 +500,15 @@ Instructions for you:
500500
- Use Markdown format for review comment text.
501501
- Fenced code blocks must be used for new content and replacement
502502
code/text snippets.
503-
- If needed, provide a replacement suggestion using the exact line number
504-
range and fenced code blocks with the suggestion language identifier.
505-
These can be directly committed by the user in the GitHub UI. Replacement
506-
code/text snippets must be complete and correctly formatted. For instance,
503+
- If needed, provide a replacement suggestion using fenced code blocks
504+
with the \`suggestion\` as the language identifier. The line number range
505+
in the review section must map exactly to the line number range that need
506+
to be replaced within a new_hunk_for_review. These snippets will be
507+
directly committed by the user using the GitHub UI. For instance,
507508
if 2 lines of code in a hunk need to be replaced with 15 lines of code,
508-
the line number range must be those exact 2 lines. If an entire hunk need to
509-
be replaced with new code, then the line number range must be the entire hunk.
509+
the line number range must be those exact 2 lines. If an entire hunk need
510+
to be replaced with new code, then the line number range must be the entire
511+
hunk. Replacement code/text snippets must be complete and correctly formatted.
510512
- If needed, suggest new code using the correct language identifier in the
511513
fenced code blocks. These snippets may be added to a different file, such
512514
as test cases.

0 commit comments

Comments
 (0)