Skip to content

Commit

Permalink
Merge pull request #1433 from Codium-ai/fix-implement-docs
Browse files Browse the repository at this point in the history
Refine `implement` tool documentation and remove outdated notes
  • Loading branch information
mrT23 authored Jan 2, 2025
2 parents 5bf5f63 + 79d589e commit ee91333
Showing 1 changed file with 4 additions and 10 deletions.
14 changes: 4 additions & 10 deletions docs/docs/tools/implement.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
Expand All @@ -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

Expand All @@ -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#.

0 comments on commit ee91333

Please sign in to comment.