Skip to content

Commit

Permalink
Add documentation for /implement tool in tools section and related files
Browse files Browse the repository at this point in the history
  • Loading branch information
ofir-frd committed Dec 25, 2024
1 parent 12d603f commit 796b36f
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 1 deletion.
22 changes: 22 additions & 0 deletions docs/docs/tools/implement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## 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.


To use the tool, manually invoke it by commenting in any PR discussion that contains code suggestions:
```
/implement
```

## Example usage

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}


**Notes** <br>
- Languages that are currently supported by the tool: Python, Java, C++, JavaScript, TypeScript, C#. <br>
- Use `/implement <discuttion comment URL>` to indirectly call the tool.
2 changes: 1 addition & 1 deletion docs/docs/tools/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ Here is a list of Qodo Merge tools, each with a dedicated page that explains how
| **💎 [Generate Tests (`/test component_name`](./test.md))** | Automatically generates unit tests for a selected component, based on the PR code changes |
| **💎 [Improve Component (`/improve_component component_name`](./improve_component.md))** | Generates code suggestions for a specific code component that changed in the PR |
| **💎 [CI Feedback (`/checks ci_job`](./ci_feedback.md))** | Automatically generates feedback and analysis for a failed CI job |

| **💎 [Implement (`/implement`](./implement.md))** | Generates implementation code from review suggestions |
Note that the tools marked with 💎 are available only for Qodo Merge Pro users.
1 change: 1 addition & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@ nav:
- 💎 Custom Prompt: 'tools/custom_prompt.md'
- 💎 CI Feedback: 'tools/ci_feedback.md'
- 💎 Similar Code: 'tools/similar_code.md'
- 💎 Implement: 'tools/implement.md'
- Core Abilities:
- 'core-abilities/index.md'
- Fetching ticket context: 'core-abilities/fetching_ticket_context.md'
Expand Down

0 comments on commit 796b36f

Please sign in to comment.