ti.sil/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-12-12 02:45:18 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #1945 from abhinav-1305/fix/doc

Browse source 
fix: update documentation for tools
This commit is contained in:
Tal 2025-07-23 08:48:24 +03:00 committed by GitHub
commit 179fef796d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 9 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/docs/tools/help_docs.md
View file

@ -89,7 +89,8 @@ jobs:
export github__user_token=$GITHUB_TOKEN && \ export github__user_token=$GITHUB_TOKEN && \
export github__base_url=$GITHUB_API_URL && \ export github__base_url=$GITHUB_API_URL && \
export openai__key=$OPENAI_KEY && \ export openai__key=$OPENAI_KEY && \
python -m pr_agent.cli --issue_url=$ISSUE_URL --pr_help_docs.repo_url="..." --pr_help_docs.docs_path="..." --pr_help_docs.openai_key=$OPENAI_KEY && \help_docs \"$ISSUE_BODY\"" python -m pr_agent.cli --issue_url=$ISSUE_URL --pr_help_docs.repo_url="..." --pr_help_docs.docs_path="..." --pr_help_docs.openai_key=$OPENAI_KEY && \
help_docs "$ISSUE_BODY"
``` ```
3) Following completion of the remaining steps (such as adding secrets and relevant configurations, such as `repo_url` and `docs_path`) merge this change to your main branch. 3) Following completion of the remaining steps (such as adding secrets and relevant configurations, such as `repo_url` and `docs_path`) merge this change to your main branch.

2
docs/docs/tools/improve_component.md
View file

@ -1,6 +1,6 @@
## Overview ## Overview
The `improve_component` tool generates code suggestions for a specific code component that changed in the PR. The `improve_component` tool generates code suggestions for a specific code component that has changed in the PR.
it can be invoked manually by commenting on any PR: it can be invoked manually by commenting on any PR:
``` ```

4
docs/docs/tools/review.md
View file

@ -1,6 +1,6 @@
## Overview ## Overview
The `review` tool scans the PR code changes, and generates a list of feedbacks about the PR, aiming to aid the reviewing process. The `review` tool scans the PR code changes, and generates feedback about the PR, aiming to aid the reviewing process.
<br> <br>
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 can be invoked manually by commenting on any PR: 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 can be invoked manually by commenting on any PR:
@ -8,7 +8,7 @@ The tool can be triggered automatically every time a new PR is [opened](../usage
/review /review
``` ```
Note that the main purpose of the `review` tool is to provide the **PR reviewer** with useful feedbacks and insights. The PR author, in contrast, may prefer to save time and focus on the output of the [improve](./improve.md) tool, which provides actionable code suggestions. Note that the main purpose of the `review` tool is to provide the **PR reviewer** with useful feedback and insights. The PR author, in contrast, may prefer to save time and focus on the output of the [improve](./improve.md) tool, which provides actionable code suggestions.
(Read more about the different personas in the PR process and how Qodo Merge aims to assist them in our [blog](https://www.codium.ai/blog/understanding-the-challenges-and-pain-points-of-the-pull-request-cycle/)) (Read more about the different personas in the PR process and how Qodo Merge aims to assist them in our [blog](https://www.codium.ai/blog/understanding-the-challenges-and-pain-points-of-the-pull-request-cycle/))

4
docs/docs/tools/similar_code.md
View file

@ -6,7 +6,7 @@ The similar code tool retrieves the most similar code components from inside the
For example: For example:
`Global Search` for a method called `chat_completion`: A `Global Search` for a method called `chat_completion`:
![similar code global](https://codium.ai/images/pr_agent/similar_code_global2.png){width=768} ![similar code global](https://codium.ai/images/pr_agent/similar_code_global2.png){width=768}
@ -21,7 +21,7 @@ Search result link example:
![code search result single](https://codium.ai/images/pr_agent/code_search_result_single.png){width=768} ![code search result single](https://codium.ai/images/pr_agent/code_search_result_single.png){width=768}
`Organization Search`: An `Organization Search`:
![similar code org](https://codium.ai/images/pr_agent/similar_code_org.png){width=768} ![similar code org](https://codium.ai/images/pr_agent/similar_code_org.png){width=768}

2
docs/docs/tools/test.md
View file

@ -1,6 +1,6 @@
## Overview ## Overview
By combining LLM abilities with static code analysis, the `test` tool generate tests for a selected component, based on the PR code changes. By combining LLM abilities with static code analysis, the `test` tool generates tests for a selected component, based on the PR code changes.
It can be invoked manually by commenting on any PR: It can be invoked manually by commenting on any PR:
``` ```