From ea3a34be0808ada29892ab11d6275357033c2bad Mon Sep 17 00:00:00 2001 From: Tal Date: Wed, 7 Feb 2024 07:31:21 +0200 Subject: [PATCH] Update DESCRIBE.md --- docs/DESCRIBE.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/docs/DESCRIBE.md b/docs/DESCRIBE.md index e321df18..a17d371b 100644 --- a/docs/DESCRIBE.md +++ b/docs/DESCRIBE.md @@ -52,20 +52,23 @@ To edit [configurations](./../pr_agent/settings/configuration.toml#L46) related ### Inline file summary 💎 > This feature is available only in PR-Agent Pro -This will enable you to quickly understand the changes in each file while reviewing the code changes (diff view). +This feature will enable you to quickly understand the changes in each file while reviewing the code changes (diff view). To add the walkthrough table to the "Files changed" tab, you can click on the checkbox that appears PR Description status message below the main PR Description: If you prefer to have the file summaries appear in the "Files changed" tab on every PR, change the `pr_description.inline_file_summary` parameter in the configuration file, possible values are: + - `'table'`: File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab. - + + - `true`: A collapsable file comment with changes title and a changes summary for each file in the PR. - + + - `false` (`default`): File changes walkthrough will be added only to the "Conversation" tab. -*Note that this feature is currently available only for GitHub. +Note that this feature is currently available only for GitHub. ### Handle custom labels from the Repo's labels page :gem: @@ -86,7 +89,7 @@ The description should be comprehensive and detailed, indicating when to add the ### Markers template To enable markers, set `pr_description.use_description_markers=true`. -markers enable to easily integrate user's content and auto-generated content, with a template-like mechanism. +Markers enable to easily integrate user's content and auto-generated content, with a template-like mechanism. For example, if the PR original description was: ```