diff --git a/docs/docs/tools/implement.md b/docs/docs/tools/implement.md index 529541ab8..281003b36 100644 --- a/docs/docs/tools/implement.md +++ b/docs/docs/tools/implement.md @@ -4,19 +4,53 @@ The `implement` tool automatically generates implementation code based on PR rev It combines LLM capabilities with static code analysis to help developers implement code changes quickly and with confidence. -To use the tool, manually invoke it by commenting in any PR discussion that contains code suggestions: +## Usage Scenarios + + +### 1. For Reviewers + +Reviewers can request code changes by:
+1. Selecting the code block to be modified.
+2. Adding a comment with the syntax: +``` +/implement +``` + +![implement1](https://codium.ai/images/pr_agent/implement1.png){width=768} + + +### 2. For PR Authors + +PR authors can implement suggested changes by replying to a review comment using either:
+1. Add specific implementation details as described above +``` +/implement +``` +2. Use the original review comment as instructions ``` /implement ``` -## Example usage +![implement2](https://codium.ai/images/pr_agent/implement2.png){width=768} + +### 3. For Referencing Comments + +You can reference and implement changes from any comment by: +``` +/implement +``` + +![implement3](https://codium.ai/images/pr_agent/implement3.png){width=768} + +Note that the implementation will occur within the review discussion thread. Invoke the tool manually by commenting `/implement` on any PR review discussion. -The tool will generate code implementation for the selected discussion: -![implement1](https://codium.ai/images/pr_agent/implement1.png){width=768} +**Configuration options**
+- Use `/implement` to implement code change within and based on the review discussion.
+- Use `/implement ` inside a review discussion to implement specific instructions.
+- Use `/implement ` to indirectly call the tool from any comment.
**Notes**
-- Languages that are currently supported by the tool: Python, Java, C++, JavaScript, TypeScript, C#.
-- Use `/implement ` to indirectly call the tool. \ No newline at end of file +- Languages that are currently supported by the tool: Python, Java, C++, JavaScript, TypeScript, C#.