From 6d0ed06fc4dcb793e4dbec3addf62ad2aa12e718 Mon Sep 17 00:00:00 2001 From: ofir-frd Date: Thu, 2 Jan 2025 12:39:14 +0200 Subject: [PATCH 1/2] Refine /implement tool documentation and remove language support notes --- docs/docs/tools/implement.md | 14 ++++---------- 1 file changed, 4 insertions(+), 10 deletions(-) diff --git a/docs/docs/tools/implement.md b/docs/docs/tools/implement.md index a3e24d26d..1c38e8ace 100644 --- a/docs/docs/tools/implement.md +++ b/docs/docs/tools/implement.md @@ -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:
/implement ``` -![implement1](https://codium.ai/images/pr_agent/implement1.png){width=768} +![implement1](https://codium.ai/images/pr_agent/implement1.png){width=600} ### 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=600} ### 3. For Referencing Comments @@ -41,16 +39,12 @@ You can reference and implement changes from any comment by: /implement ``` -![implement3](https://codium.ai/images/pr_agent/implement3.png){width=768} +![implement3](https://codium.ai/images/pr_agent/implement3.png){width=600} 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**
- 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**
-- The following languages are currently supported: Python, Java, C++, JavaScript, TypeScript, C#. From 79d589e145fd48b5264c0f1a90b78e6b15624318 Mon Sep 17 00:00:00 2001 From: ofir-frd Date: Thu, 2 Jan 2025 12:56:55 +0200 Subject: [PATCH 2/2] Adjust image widths in /implement tool documentation --- docs/docs/tools/implement.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/docs/tools/implement.md b/docs/docs/tools/implement.md index 1c38e8ace..4b1b69aa9 100644 --- a/docs/docs/tools/implement.md +++ b/docs/docs/tools/implement.md @@ -15,7 +15,7 @@ Reviewers can request code changes by:
/implement ``` -![implement1](https://codium.ai/images/pr_agent/implement1.png){width=600} +![implement1](https://codium.ai/images/pr_agent/implement1.png){width=512} ### 2. For PR Authors @@ -30,7 +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=600} +![implement2](https://codium.ai/images/pr_agent/implement2.png){width=512} ### 3. For Referencing Comments @@ -39,7 +39,7 @@ You can reference and implement changes from any comment by: /implement ``` -![implement3](https://codium.ai/images/pr_agent/implement3.png){width=600} +![implement3](https://codium.ai/images/pr_agent/implement3.png){width=512} Note that the implementation will occur within the review discussion thread.