From 056adc6545fa6fccbfcf06f44950917121be66c6 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Wed, 30 Apr 2025 11:14:50 +0300 Subject: [PATCH] Update documentation for improve tool by removing GitHub link and clarifying text --- docs/docs/tools/improve.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/docs/tools/improve.md b/docs/docs/tools/improve.md index f190990c..726f5462 100644 --- a/docs/docs/tools/improve.md +++ b/docs/docs/tools/improve.md @@ -1,6 +1,6 @@ ## Overview -The `improve` tool scans the PR code changes, and automatically generates [meaningful](https://github.com/Codium-ai/pr-agent/blob/main/pr_agent/settings/pr_code_suggestions_prompts.toml#L41) suggestions for improving the PR code. +The `improve` tool scans the PR code changes, and automatically generates meaningful suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is [opened](../usage-guide/automations_and_usage.md#github-app-automatic-tools-when-a-new-pr-is-opened), or it can be invoked manually by commenting on any PR: ```toml @@ -21,7 +21,7 @@ The tool can be triggered automatically every time a new PR is [opened](../usage Invoke the tool manually by commenting `/improve` on any PR. The code suggestions by default are presented as a single comment: -To edit [configurations](#configuration-options) related to the improve tool, use the following template: +To edit [configurations](#configuration-options) related to the `improve` tool, use the following template: ```toml /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...