2024-03-31 09:13:25 +00:00
## Overview
The `improve_component` tool generates code suggestions for a specific code component that changed in the PR.
it can be invoked manually by commenting on any PR:
```
/improve_component component_name
```
To get a list of the components that changed in the PR and choose the relevant component interactively, use the [`analyze` ](./analyze.md ) tool.
2024-04-18 07:04:38 +00:00
## Example usage
Invoke the tool manually by commenting `/improve_component` on any PR:
2024-03-31 09:13:25 +00:00
{width=768}
2024-04-18 07:04:38 +00:00
The tool will generate code suggestions for the selected component (if no component is stated, it will generate code suggestions for the largest component):
2024-03-31 09:13:25 +00:00
{width=768}
**Notes**
2024-03-31 09:15:29 +00:00
- Language that are currently supported by the tool: Python, Java, C++, JavaScript, TypeScript, C#.
2024-04-18 07:04:38 +00:00
- This tool can also be triggered interactively by using the [`analyze` ](./analyze.md ) tool.
2024-03-31 09:13:25 +00:00
## Configuration options
- `num_code_suggestions` : number of code suggestions to provide. Default is 4
- `extra_instructions` : Optional extra instructions to the tool. For example: "focus on ...".
- `file` : in case there are several components with the same name, you can specify the relevant file.
- `class_name` : in case there are several methods with the same name in the same file, you can specify the relevant class name.