diff --git a/docs/docs/tools/improve.md b/docs/docs/tools/improve.md index 6a5680e9..8d0850e6 100644 --- a/docs/docs/tools/improve.md +++ b/docs/docs/tools/improve.md @@ -29,7 +29,7 @@ To edit [configurations](#configuration-options) related to the `improve` tool, /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=... ``` -For example, you can choose to present all the suggestions as commitable code comments, by running the following command: +For example, you can choose to present all the suggestions as committable code comments, by running the following command: ```toml /improve --pr_code_suggestions.commitable_code_suggestions=true @@ -68,13 +68,13 @@ Qodo Merge tracks two types of implementations for tracking implemented suggesti - Direct implementation - when the user directly applies the suggestion by clicking the `Apply` checkbox. - Indirect implementation - when the user implements the suggestion in their IDE environment. In this case, Qodo Merge will utilize, after each commit, a dedicated logic to identify if a suggestion was implemented, and will mark it as implemented. -![code_suggestions_asses_impact](https://codium.ai/images/pr_agent/code_suggestions_asses_impact.png){width=512} +![code_suggestions_assess_impact](https://codium.ai/images/pr_agent/code_suggestions_asses_impact.png){width=512} In post-process, Qodo Merge counts the number of suggestions that were implemented, and provides general statistics and insights about the suggestions' impact on the PR process. -![code_suggestions_asses_impact_stats_1](https://codium.ai/images/pr_agent/code_suggestions_asses_impact_stats_1.png){width=512} +![code_suggestions_assess_impact_stats_1](https://codium.ai/images/pr_agent/code_suggestions_asses_impact_stats_1.png){width=512} -![code_suggestions_asses_impact_stats_2](https://codium.ai/images/pr_agent/code_suggestions_asses_impact_stats_2.png){width=512} +![code_suggestions_assess_impact_stats_2](https://codium.ai/images/pr_agent/code_suggestions_asses_impact_stats_2.png){width=512} ## Suggestion tracking @@ -119,7 +119,7 @@ Examples for possible instructions: ```toml [pr_code_suggestions] extra_instructions="""\ -(1) Answer in japanese +(1) Answer in Japanese (2) Don't suggest to add try-except block (3) Ignore changes in toml files ... @@ -138,7 +138,7 @@ This page can contain a list of best practices, coding standards, and guidelines The AI model will use this `best_practices.md` file as a reference, and in case the PR code violates any of the guidelines, it will create additional suggestions, with a dedicated label: `Organization best practice`. -Example for a python `best_practices.md` content: +Example for a Python `best_practices.md` content: ```markdown ## Project best practices @@ -273,7 +273,7 @@ Each generated suggestion consists of three key elements: 3. A diff snippet showing the recommended code modification (before and after) We advise users to apply critical analysis and judgment when implementing the proposed suggestions. -In addition to mistakes (which may happen, but are rare), sometimes the presented code modification may serve more as an _illustrative example_ than a direct applicable solution. +In addition to mistakes (which may happen, but are rare), sometimes the presented code modification may serve more as an _illustrative example_ than a directly applicable solution. In such cases, we recommend prioritizing the suggestion's detailed description, using the diff snippet primarily as a supporting reference. @@ -320,7 +320,7 @@ enable_chat_in_code_suggestions = true Our recommended approach for presenting code suggestions is through a [table](https://qodo-merge-docs.qodo.ai/tools/improve/#overview) (`--pr_code_suggestions.commitable_code_suggestions=false`). This method significantly reduces the PR footprint and allows for quick and easy digestion of multiple suggestions. -We also offer a complementary **dual publishing mode**. When enabled, suggestions exceeding a certain score threshold are not only displayed in the table, but also presented as commitable PR comments. +We also offer a complementary **dual publishing mode**. When enabled, suggestions exceeding a certain score threshold are not only displayed in the table, but also presented as committable PR comments. This mode helps highlight suggestions deemed more critical. To activate dual publishing mode, use the following setting: @@ -330,7 +330,7 @@ To activate dual publishing mode, use the following setting: dual_publishing_score_threshold = x ``` -Where x represents the minimum score threshold (>=) for suggestions to be presented as commitable PR comments in addition to the table. Default is -1 (disabled). +Where x represents the minimum score threshold (>=) for suggestions to be presented as committable PR comments in addition to the table. Default is -1 (disabled). ### Self-review @@ -478,7 +478,7 @@ Note: Chunking is primarily relevant for large PRs. For most PRs (up to 600 line commitable_code_suggestions - If set to true, the tool will display the suggestions as commitable code comments. Default is false. + If set to true, the tool will display the suggestions as committable code comments. Default is false. enable_chat_in_code_suggestions @@ -486,7 +486,7 @@ Note: Chunking is primarily relevant for large PRs. For most PRs (up to 600 line dual_publishing_score_threshold - Minimum score threshold for suggestions to be presented as commitable PR comments in addition to the table. Default is -1 (disabled). + Minimum score threshold for suggestions to be presented as committable PR comments in addition to the table. Default is -1 (disabled). focus_only_on_problems @@ -553,6 +553,6 @@ Note: Chunking is primarily relevant for large PRs. For most PRs (up to 600 line - **Self-reflection:** The suggestions aim to enable developers to _self-reflect_ and improve their pull requests. This process can help to identify blind spots, uncover missed edge cases, and enhance code readability and coherency. Even when a specific code suggestion isn't suitable, the underlying issue it highlights often reveals something important that might deserve attention. - **Bug detection:** The suggestions also alert on any _critical bugs_ that may have been identified during the analysis. This provides an additional safety net to catch potential issues before they make it into production. It's perfectly acceptable to implement only the suggestions you find valuable for your specific context. - **Hierarchy:** Presenting the suggestions in a structured hierarchical table enables the user to _quickly_ understand them, and to decide which ones are relevant and which are not. -- **Customization:** To guide the model to suggestions that are more relevant to the specific needs of your project, we recommend to use the [`extra_instructions`](https://qodo-merge-docs.qodo.ai/tools/improve/#extra-instructions-and-best-practices) and [`best practices`](https://qodo-merge-docs.qodo.ai/tools/improve/#best-practices) fields. +- **Customization:** To guide the model to suggestions that are more relevant to the specific needs of your project, we recommend using the [`extra_instructions`](https://qodo-merge-docs.qodo.ai/tools/improve/#extra-instructions-and-best-practices) and [`best practices`](https://qodo-merge-docs.qodo.ai/tools/improve/#best-practices) fields. - **Model Selection:** SaaS users can also [choose](https://qodo-merge-docs.qodo.ai/usage-guide/qodo_merge_models/) between different models. For specific programming languages or use cases, some models may perform better than others. - **Interactive usage:** The interactive [PR chat](https://qodo-merge-docs.qodo.ai/chrome-extension/) also provides an easy way to get more tailored suggestions and feedback from the AI model.