diff --git a/docs/docs/tools/describe.md b/docs/docs/tools/describe.md index 33c96e96..3351b802 100644 --- a/docs/docs/tools/describe.md +++ b/docs/docs/tools/describe.md @@ -49,7 +49,8 @@ To edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agen - `enable_semantic_files_types`: if set to true, "Changes walkthrough" section will be generated. Default is true. - `collapsible_file_list`: if set to true, the file list in the "Changes walkthrough" section will be collapsible. If set to "adaptive", the file list will be collapsible only if there are more than 8 files. Default is "adaptive". - + - `enable_help_text`: if set to true, the tool will display a help text in the comment. Default is true. + ### Inline file summary 💎 This feature enables you to copy the `changes walkthrough` table to the "Files changed" tab, so you can quickly understand the changes in each file while reviewing the code changes (diff view). diff --git a/docs/docs/tools/review.md b/docs/docs/tools/review.md index 8a571983..a8bd5a66 100644 --- a/docs/docs/tools/review.md +++ b/docs/docs/tools/review.md @@ -33,6 +33,7 @@ To edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agen - `inline_code_comments`: if set to true, the tool will publish the code suggestions as comments on the code diff. Default is false. - `persistent_comment`: if set to true, the review comment will be persistent, meaning that every new review request will edit the previous one. Default is true. - `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...". + - `enable_help_text`: if set to true, the tool will display a help text in the comment. Default is true. !!! example "Enable\\disable sub-sections" You can enable or disable specific sub-sections of the review tool: