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

## Example usage

Browse Source
This commit is contained in:
mrT23
2024-04-18 10:04:38 +03:00
parent 0f99db65a9
commit ea4d4ab618
10 changed files with 52 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
docs/docs/tools/improve_component.md
View File

@ -8,14 +8,19 @@ it can be invoked manually by commenting on any PR:
To get a list of the components that changed in the PR and choose the relevant component interactively, use the [`analyze`](./analyze.md) tool.
Example result:
## Example usage
Invoke the tool manually by commenting `/improve_component` on any PR:
![improve_component1](https://codium.ai/images/pr_agent/improve_component1.png){width=768}
The tool will generate code suggestions for the selected component (if no component is stated, it will generate code suggestions for the largest component):
![improve_component2](https://codium.ai/images/pr_agent/improve_component2.png){width=768}
**Notes**
- Language that are currently supported by the tool: Python, Java, C++, JavaScript, TypeScript, C#.
- This tool can also be triggered interactively by using the [`analyze`](./analyze.md) tool.
## Configuration options
- `num_code_suggestions`: number of code suggestions to provide. Default is 4