Update additional_configurations.md

[mrT23]

Type

documentation, enhancement

---

Description

• Corrected capitalization and improved verb tense consistency across the document for better readability.
• Added model_turbo configuration option for AI models, enhancing the documentation with more detailed examples.
• Clarified strategies for handling large PRs, including the use of models with larger context and the 'extended' mode for the /improve tool.
• Updated instructions on setting keys for AI models, with a new mention of Google's Vertex AI platform.
• Standardized numerical expressions for consistency.

---

Changes walkthrough

Relevant files

Documentation

additional_configurations.md Enhancements and Clarifications in Additional Configurations Documentation docs/docs/usage-guide/additional_configurations.md Corrected capitalization of "Python" in examples. Improved verb tense consistency for better readability. Introduced the option model_turbo in configuration examples for different AI models. Provided clarity on handling large PRs with two possible solutions. Updated instructions for setting keys for AI models, including a new section for Google's Vertex AI. Adjusted the default context lines in git patches from "3" to "three" for consistency. +11/-7

---

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

[codiumai-pr-agent-pro]

PR Description updated to latest commit (bbd3023)

• Copy walkthrough table to "Files Changed" Tab

[codiumai-pr-agent-pro]

PR Review

⏱️ Estimated effort to review [1-5]	2, because the changes are primarily textual with clear intentions, focusing on documentation improvements and consistency. The technical complexity is low, making it easier to review.
🏅 Score	92
🧪 Relevant tests	No
🔍 Possible issues	No
🔒 Security concerns	No
🔀 Multiple PR themes	No

---

✨ 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
Maintainability	Ensure consistent and clear model naming across the documentation. Consider using consistent terminology for model names across the documentation to avoid confusion. For example, if you use "ollama/llama2" in one section, ensure that all references to this model throughout the document are consistent. This helps in maintaining clarity and reduces the risk of errors when configuring models. docs/docs/usage-guide/additional_configurations.md [81-82] model = "ollama/llama2" -model_turbo = "ollama/llama2" +model_turbo = "ollama/llama2-turbo" # If a different model configuration is intended for turbo, specify it clearly
Enhancement	Avoid abbreviations or explain them to enhance document readability. To improve readability and ensure that the documentation is accessible to a wider audience, consider avoiding abbreviations or explaining them upon first use. For instance, instead of using "PR" without explanation, define it as "Pull Request (PR)" the first time it appears in the document. docs/docs/usage-guide/additional_configurations.md [10] -For example, to ignore Python files in a PR with online usage, comment on a PR: +For example, to ignore Python files in a Pull Request (PR) with online usage, comment on a PR:
	Describe the benefits or use cases of modes or options directly in the documentation. When introducing options or modes, such as the 'extended' mode for the /improve tool, it's helpful to briefly describe the benefits or use cases directly in the documentation. This provides readers with immediate understanding of why and when to use certain features. docs/docs/usage-guide/additional_configurations.md [35] -which divides the PR to chunks, and processes each chunk separately. With this mode, regardless of the model, no compression will be done (but for large PRs, multiple model calls may occur) +which divides the PR into chunks, and processes each chunk separately. This mode is particularly useful for very large PRs where maintaining quality is a priority over speed and cost. With this mode, regardless of the model, no compression will be done, ensuring a thorough review.
	Use consistent numerical representation throughout the documentation. When documenting numerical values, consistency in representation can enhance clarity. For example, choose between spelling out numbers (e.g., "three") or using digits (e.g., "3") and apply it consistently throughout the document. This minor adjustment can significantly improve the readability of the documentation. docs/docs/usage-guide/additional_configurations.md [190] -By default, around any change in your PR, git patch provides three lines of context above and below the change. +By default, around any change in your PR, git patch provides 3 lines of context above and below the change.
Best practice	Provide complete, usable examples in documentation instead of placeholders. For documentation that includes code snippets or configurations, it's beneficial to include examples or templates that are fully ready to use. This means avoiding placeholder text like '...' which might confuse readers. Instead, provide a complete, minimal example that users can directly apply or modify. docs/docs/usage-guide/additional_configurations.md [85] -api_base = ... # the base url for your huggingface inference endpoint +api_base = "https://api.huggingface.co" # Example base URL for HuggingFace inference endpoint

---

✨ 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.