From 5d81f31ccc407f8a6bd6a56956833b612a63cf91 Mon Sep 17 00:00:00 2001 From: Hussam Lawen Date: Tue, 6 Feb 2024 21:18:56 +0200 Subject: [PATCH] Update DESCRIBE.md --- docs/DESCRIBE.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/DESCRIBE.md b/docs/DESCRIBE.md index 00526a87..526b31a3 100644 --- a/docs/DESCRIBE.md +++ b/docs/DESCRIBE.md @@ -52,8 +52,12 @@ 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). -To enable inline file summary, set `pr_description.inline_file_summary` in the configuration file, possible values are: +This 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.