## Example usage

[mrT23]

Type

documentation, enhancement

---

Description

• Added or enhanced "Example usage" sections across various tool documentation pages to improve user understanding and provide clear examples.
• Updated configuration options and clarified tool functionalities to ensure the documentation is current and accurate.

---

Changes walkthrough

Relevant files

Documentation

10 files analyze.md Add Example Usage Section for Analyze Tool                              docs/docs/tools/analyze.md Added a section titled "Example usage" to illustrate the tool's output. +1/-0      ci_feedback.md Document Example Usage for CI Feedback Tool                            docs/docs/tools/ci_feedback.md Introduced an "Example usage" section with an image to demonstrate the tool's output. +2/-0      custom_labels.md Enhance Custom Labels Documentation with Usage Example      docs/docs/tools/custom_labels.md Added "Example usage" heading to improve documentation clarity. +2/-1      custom_suggestions.md Refine Custom Suggestions Tool Documentation                          docs/docs/tools/custom_suggestions.md Revised text for clarity and emphasis on the specificity of suggestions. Added formatting to the example prompt for better readability. +15/-10  documentation.md Expand Documentation Tool Usage Guide                                        docs/docs/tools/documentation.md Added detailed steps and examples under "Example usage" to guide on manual invocation. Included additional information on specifying components for documentation. +12/-3    improve.md Update Configuration Options in Improve Tool                          docs/docs/tools/improve.md Changed a configuration option to reflect commitable code suggestions. +1/-1      improve_component.md Document Example Usage for Improve Component Tool                docs/docs/tools/improve_component.md Added "Example usage" section with instructions for manual invocation. Clarified the scope of suggestions for selected components. +6/-1      similar_issues.md Add Usage Example for Similar Issues Tool                                docs/docs/tools/similar_issues.md Introduced an "Example usage" section to enhance user guidance. +3/-1      test.md Enhance Test Tool Documentation with Detailed Examples      docs/docs/tools/test.md Added a comprehensive "Example usage" section with detailed steps and links. +7/-1      update_changelog.md Update Changelog Tool Documentation with Usage Examples    docs/docs/tools/update_changelog.md Added an "Example usage" section to guide users on how to use the tool. +3/-2

---

✨ PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[mrT23]

/review auto_approve

[codiumai-pr-agent-pro]

Auto-approved PR

[codiumai-pr-agent-pro]

PR Description updated to latest commit (ea4d4ab)

• Copy walkthrough table to "Files Changed" Tab

[codiumai-pr-agent-pro]

PR Review

(Review updated until commit a9d30c1)

⏱️ Estimated effort to review [1-5]	2, because the PR primarily involves documentation updates which are generally straightforward to review. The changes are mostly additions of "Example usage" sections across various documentation files.
🏅 Score	85
🧪 Relevant tests	No
🔍 Possible issues	No
🔒 Security concerns	No

Code feedback:

---

✨ Review tool usage guide:

---

Overview:
The review tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be added by configuring the tool.

The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.

• When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

• With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

See the review usage page for a comprehensive guide on using this tool.

[codiumai-pr-agent-pro]

PR Code Suggestions

Category	Suggestions
Enhancement	Correct a spelling mistake in the documentation. Correct the typo in the word "Remember" which is mistakenly written as "Remmeber". docs/docs/tools/custom_suggestions.md [30] -Remmeber - with this tool, you are the prompter. Be specific, clear, and concise in the instructions. Specify relevant aspects that you want the model to focus on. +Remember - with this tool, you are the prompter. Be specific, clear, and concise in the instructions. Specify relevant aspects that you want the model to focus on.
	Enhance the clarity of the tool's configuration option description. Clarify the description of the commitable_code_suggestions option to explain what "commitable code comments" means, as it might be unclear to users. docs/docs/tools/improve.md [59] -- `commitable_code_suggestions`: if set to true, the tool will display the suggestions as commitable code comments. Default is false. +- `commitable_code_suggestions`: if set to true, the tool will display the suggestions as commitable code comments, which can be directly applied as commits from the PR interface. Default is false.
	Clarify behavior when multiple components are equally large. Specify what happens if multiple components are equally large when no specific component is stated, to avoid ambiguity. docs/docs/tools/improve_component.md [17] -The tool will generate code suggestions for the selected component (if no component is stated, it will generate code suggestions for the largest component): +The tool will generate code suggestions for the selected component. If no specific component is stated and multiple components are equally large, it will prompt the user to select one. Otherwise, it will generate code suggestions for the largest component.
	Provide more detailed information about the types of tests generated by the tool. Add a brief explanation about what kind of tests are generated (e.g., unit, integration) to provide clearer expectations for users. docs/docs/tools/test.md [16] -The tool will generate tests for the selected component (if no component is stated, it will generate tests for largest component): +The tool will generate unit and integration tests for the selected component (if no component is stated, it will generate tests for the largest component):

---

✨ Improve tool usage guide:

---

Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.

• When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

• With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

See the improve usage page for a comprehensive guide on using this tool.

[mrT23]

/help

[codiumai-pr-agent-pro]

PR Agent Walkthrough

🤖 Welcome to the PR Agent, an AI-powered tool for automated pull request analysis, feedback, suggestions and more.

Here is a list of tools you can use to interact with the PR Agent:

Tool	Description	Trigger Interactively 💎
DESCRIBE	Generates PR description - title, type, summary, code walkthrough and labels	Run
REVIEW	Adjustable feedback about the PR, possible issues, security concerns, review effort and more	Run
IMPROVE	Code suggestions for improving the PR	Run
UPDATE CHANGELOG	Automatically updates the changelog	Run
ADD DOCS 💎	Generates documentation to methods/functions/classes that changed in the PR	Run
TEST 💎	Generates unit tests for a specific component, based on the PR code change	Run
IMPROVE COMPONENT 💎	Code suggestions for a specific component that changed in the PR	Run
ANALYZE 💎	Identifies code components that changed in the PR, and enables to interactively generate tests, docs, and code suggestions for each component	Run
ASK	Answering free-text questions about the PR	[*]
GENERATE CUSTOM LABELS 💎	Generates custom labels for the PR, based on specific guidelines defined by the user	[*]
CI FEEDBACK 💎	Generates feedback and analysis for a failed CI job	[*]
CUSTOM SUGGESTIONS 💎	Generates custom suggestions for improving the PR code, based only on specific guidelines defined by the user	[*]
SIMILAR ISSUE	Automatically retrieves and presents similar issues	[*]

(1) Note that each tool be triggered automatically when a new PR is opened, or called manually by commenting on a PR.

(2) Tools marked with [*] require additional parameters to be passed. For example, to invoke the /ask tool, you need to comment on a PR: /ask "<question content>". See the relevant documentation for each tool for more details.

[mrT23]

/review

[codiumai-pr-agent-pro]

Persistent review updated to latest commit a9d30c1

[mrT23]

/describe

[codiumai-pr-agent-pro]

PR Description updated to latest commit (a9d30c1)

• Copy walkthrough table to "Files Changed" Tab