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

Merge pull request #1433 from Codium-ai/fix-implement-docs

Browse Source 
Refine `implement` tool documentation and remove outdated notes
This commit is contained in:
Tal
2025-01-02 14:01:00 +02:00
committed by GitHub
parent 5bf5f63c78 79d589e145
commit ee913336ad
1 changed files with 4 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/docs/tools/implement.md
View File

@ -1,8 +1,7 @@
## Overview
The `implement` tool automatically generates implementation code based on PR review suggestions.
It combines LLM capabilities with static code analysis to help developers implement code changes quickly and with confidence.
It combines LLM capabilities with PR review suggestions to help developers implement code changes quickly and with confidence.
## Usage Scenarios
@ -16,7 +15,7 @@ Reviewers can request code changes by: <br>
/implement <code-change-description>
```
![implement1](https://codium.ai/images/pr_agent/implement1.png){width=768}
![implement1](https://codium.ai/images/pr_agent/implement1.png){width=512}
### 2. For PR Authors
@ -31,8 +30,7 @@ PR authors can implement suggested changes by replying to a review comment using
/implement
```
![implement2](https://codium.ai/images/pr_agent/implement2.png){width=768}
![implement2](https://codium.ai/images/pr_agent/implement2.png){width=512}
### 3. For Referencing Comments
@ -41,16 +39,12 @@ You can reference and implement changes from any comment by:
/implement <link-to-review-comment>
```
![implement3](https://codium.ai/images/pr_agent/implement3.png){width=768}
![implement3](https://codium.ai/images/pr_agent/implement3.png){width=512}
Note that the implementation will occur within the review discussion thread.
Invoke the tool manually by commenting `/implement` on any PR review discussion.
**Configuration options** <br>
- Use `/implement` to implement code change within and based on the review discussion. <br>
- Use `/implement <code-change-description>` inside a review discussion to implement specific instructions. <br>
- Use `/implement <link-to-review-comment>` to indirectly call the tool from any comment. <br>
**Notes** <br>
- The following languages are currently supported: Python, Java, C++, JavaScript, TypeScript, C#.