Improve help text

This commit is contained in:
Ori Kotek
2023-07-16 17:41:23 +03:00
parent b030299547
commit d54ee252ee
2 changed files with 7 additions and 8 deletions

View File

@ -10,7 +10,7 @@
[![GitHub license](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/Codium-ai/pr-agent/blob/main/LICENSE) [![GitHub license](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://github.com/Codium-ai/pr-agent/blob/main/LICENSE)
[![Discord](https://badgen.net/badge/icon/discord?icon=discord&label&color=purple)](https://discord.com/channels/1057273017547378788/1126104260430528613) [![Discord](https://badgen.net/badge/icon/discord?icon=discord&label&color=purple)](https://discord.com/channels/1057273017547378788/1126104260430528613)
</div> </div>
<div align="left"> <div style="text-align:left;">
CodiumAI `pr-agent` is an open-source tool aiming to help developers review PRs faster and more efficiently. It automatically analyzes the PR and can provide several types of feedback: CodiumAI `pr-agent` is an open-source tool aiming to help developers review PRs faster and more efficiently. It automatically analyzes the PR and can provide several types of feedback:

View File

@ -1,14 +1,13 @@
commands_text = "> /review - Ask for a new review after your update the PR\n" \ commands_text = "> /review - Request a review of the latest update to the PR.\n" \
"> /describe - Modify the PR title and description based " \ "> /describe - Modify the PR title and description based on the contents of the PR.\n" \
"on the PR's contents.\n" \ "> /improve - Suggest improvements to the code in the PR. " \
"> /improve - Suggest improvements to the code in the PR as pull " \ "These will be provided as pull request comments, ready to commit.\n" \
"request comments ready to commit.\n" \ "> /ask <QUESTION> - Pose a question about the PR.\n"
"> /ask <QUESTION> - Ask a question about the PR.\n"
def bot_help_text(user: str): def bot_help_text(user: str):
return f"> Tag me in a comment '@{user}' and add one of the following commands:\n" + commands_text return f"> Tag me in a comment '@{user}' and add one of the following commands:\n" + commands_text
actions_help_text = "> Add a comment to to invoke PR-Agent, use one of the following commands:\n" + \ actions_help_text = "> To invoke the PR-Agent, add a comment using one of the following commands:\n" + \
commands_text commands_text