diff --git a/docs/docs/tools/review.md b/docs/docs/tools/review.md index e5cc6b93..2489a724 100644 --- a/docs/docs/tools/review.md +++ b/docs/docs/tools/review.md @@ -112,7 +112,7 @@ extra_instructions = "..." enable_review_labels_effort - If set to true, the tool will publish a 'Review effort [1-5]: x' label. Default is true. + If set to true, the tool will publish a 'Review effort x/5' label (1–5 scale). Default is true. @@ -141,7 +141,7 @@ extra_instructions = "..." The `review` tool can auto-generate two specific types of labels for a PR: - a `possible security issue` label that detects if a possible [security issue](https://github.com/Codium-ai/pr-agent/blob/tr/user_description/pr_agent/settings/pr_reviewer_prompts.toml#L136) exists in the PR code (`enable_review_labels_security` flag) - - a `Review effort [1-5]: x` label, where x is the estimated effort to review the PR (`enable_review_labels_effort` flag) + - a `Review effort x/5` label, where x is the estimated effort to review the PR on a 1–5 scale (`enable_review_labels_effort` flag) Both modes are useful, and we recommended to enable them.