From e56c443fd602318034578ccd489ce9a5215520d5 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Tue, 9 Jan 2024 16:34:27 +0200 Subject: [PATCH] ask helper --- docs/ASK.md | 2 +- pr_agent/servers/help.py | 4 ++-- pr_agent/settings/pr_questions_prompts.toml | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/ASK.md b/docs/ASK.md index ab8847d5..5e410e4a 100644 --- a/docs/ASK.md +++ b/docs/ASK.md @@ -1,6 +1,6 @@ # ASK Tool -The `ask` tool answers questions about the PR, based on the PR code changes. +The `ask` tool answers questions about the PR, based on the PR code changes. Make sure to be specific and clear in your questions. It can be invoked manually by commenting on any PR: ``` /ask "..." diff --git a/pr_agent/servers/help.py b/pr_agent/servers/help.py index 29c3f3fc..721b4652 100644 --- a/pr_agent/servers/help.py +++ b/pr_agent/servers/help.py @@ -189,7 +189,7 @@ Make sure to provide proper title, and a detailed and well-phrased description f def get_ask_usage_guide(): output = "**Overview:**\n" output += """\ -The [`ask` tool](https://github.com/Codium-ai/pr-agent/blob/main/docs/ASK.md] answers questions about the PR, based on the PR code changes. Note that the tool does not have "memory" of previous questions, and answers each question independently. +The `ask` tool answers questions about the PR, based on the PR code changes. Note that the tool does not have "memory" of previous questions, and answers each question independently. It can be invoked manually by commenting on any PR: ``` /ask "..." @@ -204,6 +204,6 @@ It can be invoked manually by commenting on any PR: output += "" - output += f"\n\nSee the [review usage](https://github.com/Codium-ai/pr-agent/blob/main/docs/REVIEW.md) page for a comprehensive guide on using this tool.\n\n" + output += f"\n\nSee the [ask usage](https://github.com/Codium-ai/pr-agent/blob/main/docs/ASK.md) page for a comprehensive guide on using this tool.\n\n" return output diff --git a/pr_agent/settings/pr_questions_prompts.toml b/pr_agent/settings/pr_questions_prompts.toml index e466d9a1..08dd769e 100644 --- a/pr_agent/settings/pr_questions_prompts.toml +++ b/pr_agent/settings/pr_questions_prompts.toml @@ -1,7 +1,7 @@ [pr_questions_prompt] -system="""You are PR-Reviewer, a language model designed to review a Git Pull Request (PR). +system="""You are PR-Reviewer, a language model designed to answer questions about a Git Pull Request (PR). -Your goal is to answer questions\\tasks about the new PR code (lines starting with '+'), and provide feedback. +Your goal is to answer questions\\tasks about the new code introduced in the PR (lines starting with '+' in the 'PR Git Diff' section), and provide feedback. Be informative, constructive, and give examples. Try to be as specific as possible. Don't avoid answering the questions. You must answer the questions, as best as you can, without adding any unrelated content. """