xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-05 13:20:39 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update review.md

Browse Source
This commit is contained in:
Tal
2024-08-18 09:16:46 +03:00
committed by GitHub
parent 435d9d41c8
commit 7cbe797108
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/docs/tools/review.md
View File

@ -92,11 +92,11 @@ num_code_suggestions = ...
<table> <table>
<tr> <tr>
<td><b>num_code_suggestions</b></td> <td><b>num_code_suggestions</b></td>
<td>Number of code suggestions provided by the 'review' tool. For manual comments, default is 4. For PR-Agent app auto tools, default is 0, meaning no code suggestions will be provided by the review tool, unless you manually edit pr_commands.</td> <td>Number of code suggestions provided by the 'review' tool. Default is 0, meaning no code suggestions will be provided by the `review` tool.</td>
</tr> </tr>
<tr> <tr>
<td><b>inline_code_comments</b></td> <td><b>inline_code_comments</b></td>
<td>If set to true, the tool will publish the code suggestions as comments on the code diff. Default is false.</td> <td>If set to true, the tool will publish the code suggestions as comments on the code diff. Default is false. Note that you need to set `num_code_suggestions`>0 to get code suggestions </td>
</tr> </tr>
<tr> <tr>
<td><b>persistent_comment</b></td> <td><b>persistent_comment</b></td>
@ -174,7 +174,7 @@ If enabled, the `review` tool can approve a PR when a specific comment, `/review
<table> <table>
<tr> <tr>
<td><b>enable_auto_approval</b></td> <td><b>enable_auto_approval</b></td>
<td>If set to true, the tool will approve the PR when invoked with the 'auto_approve' command. Default is false. This flag can be changed only from configuration file.</td> <td>If set to true, the tool will approve the PR when invoked with the 'auto_approve' command. Default is false. This flag can be changed only from a configuration file.</td>
</tr> </tr>
<tr> <tr>
<td><b>maximal_review_effort</b></td> <td><b>maximal_review_effort</b></td>
@ -200,7 +200,7 @@ If enabled, the `review` tool can approve a PR when a specific comment, `/review
pr_commands = ["/review --pr_reviewer.num_code_suggestions=0", ...] pr_commands = ["/review --pr_reviewer.num_code_suggestions=0", ...]
``` ```
Meaning the `review` tool will run automatically on every PR, without providing code suggestions. Meaning the `review` tool will run automatically on every PR, without providing code suggestions.
Edit this field to enable/disable the tool, or to change the used configurations. Edit this field to enable/disable the tool, or to change the configurations used.
!!! tip "Possible labels from the review tool" !!! tip "Possible labels from the review tool"
@ -218,7 +218,7 @@ If enabled, the `review` tool can approve a PR when a specific comment, `/review
Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize. Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.
Examples for extra instructions: Examples of extra instructions:
``` ```
[pr_reviewer] [pr_reviewer]
extra_instructions="""\ extra_instructions="""\