This commit is contained in:
mrT23
2024-04-07 10:43:56 +03:00
parent 60fd1c67fa
commit f3b4695617
3 changed files with 13 additions and 0 deletions

View File

@ -1,6 +1,8 @@
## Overview
The `help` tool provides a list of all the available tools and their descriptions.
For PR-Agent Pro users, it also enables to trigger each tool by checking the relevant box.
It can be invoked manually by commenting on any PR:
```
/help
```
@ -9,5 +11,7 @@ For PR-Agent Pro users, it also enables to trigger each tool by checking the rel
An example [result](https://github.com/Codium-ai/pr-agent/pull/546#issuecomment-1868524805):
![Help 1](https://codium.ai/images/pr_agent/help1.png){width=750}
→
![Analyze 2](https://codium.ai/images/pr_agent/help2.png){width=750}

View File

@ -7,3 +7,11 @@ If you are subscribed to notifications for a repo with PR-Agent, we recommend tu
As an alternative, you can filter in your mail provider the notifications specifically from the PR-Agent bot, [see how](https://www.quora.com/How-can-you-filter-emails-for-specific-people-in-Gmail#:~:text=On%20the%20Filters%20and%20Blocked,the%20body%20of%20the%20email).
![filter_mail_notifications](https://codium.ai/images/pr_agent/filter_mail_notifications.png){width=512}
Another option to reduce the mail overload is disable the help collapsible section in PR-Agent bot comments, by adding the relevant configurations to the `.pr_agent.toml` file.
For example, to disable the help text for the `pr_reviewer` tool, add to the configuration file:
```
[pr_reviewer]
enable_help_text = false
```

View File

@ -25,6 +25,7 @@ nav:
- Ask: 'tools/ask.md'
- Update Changelog: 'tools/update_changelog.md'
- Similar Issues: 'tools/similar_issues.md'
- Help: 'tools/help.md'
- 💎 Analyze: 'tools/analyze.md'
- 💎 Test: 'tools/test.md'
- 💎 Improve Component: 'tools/improve_component.md'