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

Update CUSTOM_SUGGESTIONS.md

Browse Source
This commit is contained in:
Tal
2024-01-21 17:31:33 +02:00
committed by GitHub
parent 5dedc381a6
commit 7178ddac10
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/CUSTOM_SUGGESTIONS.md
View File

@ -8,7 +8,7 @@
## Overview
The `custom_suggestions` tool scans the PR code changes, and automatically generates custom suggestions for improving the PR code.
It shares similarities with the `improve` tool, but with one main difference: the `custom_suggestions` tool will only propose suggestion that follow specific guidelines defined by the prompt in: `pr_custom_suggestions.prompt` configuration.
It shares similarities with the `improve` tool, but with one main difference: the `custom_suggestions` tool will only propose suggestions that follow specific guidelines defined by the prompt in: `pr_custom_suggestions.prompt` configuration.
The tool can be triggered [automatically](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) every time a new PR is opened, or can be invoked manually by commenting on a PR.
@ -36,7 +36,7 @@ You might benefit from several trial-and-error iterations, until you get the cor
## Example usage
Here is an example for a possible prompt:
Here is an example of a possible prompt:
```
[pr_custom_suggestions]
prompt="""\
@ -58,8 +58,8 @@ ___
## Configuration options
`prompt`: the prompt for the tool. Should be a multi-line string.
`prompt`: the prompt for the tool. It should be a multi-line string.
`num_code_suggestions`: number of code suggestions provided by the 'custom_suggestions' tool. Default is 4.
`enable_help_text`: if set to true, the tool will display a help text in the comment. Default is true.
`enable_help_text`: if set to true, the tool will display a help text in the comment. Default is true.