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

improve usage guide

Browse Source
This commit is contained in:
mrT23
2024-01-17 10:06:27 +02:00
parent 298c41a100
commit 7298548f82
1 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
docs/IMPROVE.md
View File

@ -16,16 +16,18 @@ The tool can be triggered automatically every time a new PR is [opened](https://
/improve /improve
``` ```
The suggestions can appear as a collapsible comment (pr_code_suggestions.summarize=true): ### Summarized vs commitable code suggestions
The code suggestions can appear as a single comment (`pr_code_suggestions.summarize=true`):
<kbd><img src=https://codium.ai/images/pr_agent/code_suggestions_as_comment.png width="768"></kbd> <kbd><img src=https://codium.ai/images/pr_agent/code_suggestions_as_comment.png width="768"></kbd>
Or as a separate commitable comment for each suggestion: Or as a separate commitable code comment for each suggestion:
<kbd><img src=https://codium.ai/images/pr_agent/improve.png width="768"></kbd> <kbd><img src=https://codium.ai/images/pr_agent/improve.png width="768"></kbd>
--- ---
Note that a collapsible comment has a significantly smaller PR footprint. Note that a single comment has a significantly smaller PR footprint. We recommend this mode for most cases.
### Extended mode ### Extended mode