diff --git a/docs/docs/tools/review.md b/docs/docs/tools/review.md index 00a6b148..67da435a 100644 --- a/docs/docs/tools/review.md +++ b/docs/docs/tools/review.md @@ -92,11 +92,11 @@ num_code_suggestions = ... - + - + @@ -174,7 +174,7 @@ If enabled, the `review` tool can approve a PR when a specific comment, `/review
num_code_suggestionsNumber 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.Number of code suggestions provided by the 'review' tool. Default is 0, meaning no code suggestions will be provided by the `review` tool.
inline_code_commentsIf set to true, the tool will publish the code suggestions as comments on the code diff. Default is false.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
persistent_comment
- + @@ -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", ...] ``` 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" @@ -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. - Examples for extra instructions: + Examples of extra instructions: ``` [pr_reviewer] extra_instructions="""\
enable_auto_approvalIf 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.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.
maximal_review_effort