Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mrT23 committed Mar 10, 2024
1 parent 10a96d6 commit 4810b85
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 2 deletions.
1 change: 1 addition & 0 deletions docs/docs/tools/review.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ To edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agen
- `require_score_review`: if set to true, the tool will add a section that scores the PR. Default is false.
- `require_tests_review`: if set to true, the tool will add a section that checks if the PR contains tests. Default is true.
- `require_estimate_effort_to_review`: if set to true, the tool will add a section that estimates the effort needed to review the PR. Default is true.
- `require_can_be_split_review`: if set to true, the tool will add a section that checks if the PR can be split into smaller PRs. Default is false.

#### SOC2 ticket compliance 💎
> This feature is available only in PR-Agent Pro
Expand Down
2 changes: 1 addition & 1 deletion pr_agent/servers/help.py
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ def get_review_usage_guide():
The `review` tool provides a collection of possible feedbacks about a PR.
It is recommended to review the [possible options](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md#enabledisable-features), and choose the ones relevant for your use case.
Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example:
`require_score_review`, `require_soc2_ticket`, and more.
`require_score_review`, `require_soc2_ticket`, `require_can_be_split_review`, and more.
"""
output += "\n\n</details></td></tr>\n\n"

Expand Down
2 changes: 1 addition & 1 deletion pr_agent/settings/pr_reviewer_prompts.toml
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ class PRReview(BaseModel):
code_feedback: List[CodeSuggestion]
{%- else %}
class PRReview(BaseModel)
class PRReview(BaseModel):
review: Review
{%- endif %}
=====
Expand Down

0 comments on commit 4810b85

Please sign in to comment.