From b4e2a325433d0ce040f55d55d75d691799d75098 Mon Sep 17 00:00:00 2001 From: ofir-frd <85901822+ofir-frd@users.noreply.github.com> Date: Fri, 14 Mar 2025 12:04:58 +0200 Subject: [PATCH] Update describe.md --- docs/docs/tools/describe.md | 100 ++++++++++++++++++------------------ 1 file changed, 50 insertions(+), 50 deletions(-) diff --git a/docs/docs/tools/describe.md b/docs/docs/tools/describe.md index d77a645e..0980923d 100644 --- a/docs/docs/tools/describe.md +++ b/docs/docs/tools/describe.md @@ -46,56 +46,56 @@ publish_labels = true !!! example "Possible configurations" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
publish_labelsIf set to true, the tool will publish labels to the PR. Default is false.
publish_description_as_commentIf set to true, the tool will publish the description as a comment to the PR. If false, it will overwrite the original description. Default is false.
publish_description_as_comment_persistentIf set to true and `publish_description_as_comment` is true, the tool will publish the description as a persistent comment to the PR. Default is true.
add_original_user_descriptionIf set to true, the tool will add the original user description to the generated description. Default is true.
generate_ai_titleIf set to true, the tool will also generate an AI title for the PR. Default is false.
extra_instructionsOptional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ..."
enable_pr_typeIf set to false, it will not show the `PR type` as a text value in the description content. Default is true.
final_update_messageIf set to true, it will add a comment message [`PR Description updated to latest commit...`](https://github.com/Codium-ai/pr-agent/pull/499#issuecomment-1837412176) after finishing calling `/describe`. Default is false.
enable_semantic_files_typesIf set to true, "Changes walkthrough" section will be generated. Default is true.
collapsible_file_listIf 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_large_pr_handlingPro feature. If set to true, in case of a large PR the tool will make several calls to the AI and combine them to be able to cover more files. Default is true.
enable_help_textIf set to true, the tool will display a help text in the comment. Default is false.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
publish_labelsIf set to true, the tool will publish labels to the PR. Default is false.
publish_description_as_commentIf set to true, the tool will publish the description as a comment to the PR. If false, it will overwrite the original description. Default is false.
publish_description_as_comment_persistentIf set to true and `publish_description_as_comment` is true, the tool will publish the description as a persistent comment to the PR. Default is true.
add_original_user_descriptionIf set to true, the tool will add the original user description to the generated description. Default is true.
generate_ai_titleIf set to true, the tool will also generate an AI title for the PR. Default is false.
extra_instructionsOptional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ..."
enable_pr_typeIf set to false, it will not show the `PR type` as a text value in the description content. Default is true.
final_update_messageIf set to true, it will add a comment message [`PR Description updated to latest commit...`](https://github.com/Codium-ai/pr-agent/pull/499#issuecomment-1837412176) after finishing calling `/describe`. Default is false.
enable_semantic_files_typesIf set to true, "Changes walkthrough" section will be generated. Default is true.
collapsible_file_listIf 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_large_pr_handlingPro feature. If set to true, in case of a large PR the tool will make several calls to the AI and combine them to be able to cover more files. Default is true.
enable_help_textIf set to true, the tool will display a help text in the comment. Default is false.
## Inline file summary 💎