Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mrT23 committed Dec 7, 2023
1 parent 7d2a35e commit f908d02
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
7 changes: 6 additions & 1 deletion docs/DESCRIBE.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Describe Tool

The `describe` tool scans the PR code changes, and automatically generates PR description - title, type, summary, code walkthrough and labels.
The `describe` tool scans the PR code changes, and automatically generates PR description - title, type, summary, walkthrough and labels.
It can be invoked manually by commenting on any PR:
```
/describe
Expand All @@ -26,9 +26,14 @@ Under the section 'pr_description', the [configuration file](./../pr_agent/setti
- `keep_original_user_title`: if set to true, the tool will keep the original PR title, and won't change it. Default is false.

- `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".

- To enable `custom labels`, apply the configuration changes described [here](./GENERATE_CUSTOM_LABELS.md#configuration-changes)

- `enable_pr_type`: if set to false, it will not show the `PR type` as a text value in the description content. Default is true.

- `final_update_message`: if 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 true.

- `enable_semantic_files_types`: if set to true, "PR changes walkthrough" section will be generated. Default is true.

### Markers template

Expand Down
2 changes: 1 addition & 1 deletion pr_agent/tools/pr_description.py
Original file line number Diff line number Diff line change
Expand Up @@ -356,7 +356,7 @@ def process_pr_files_prediction(self, pr_body, value):
<details>
<summary><strong>{filename_publish}</strong></summary>
<ul>
({filename})<br><br>
{filename}<br><br>
<strong>{file_change_description}</strong>
</ul>
</details>
Expand Down

0 comments on commit f908d02

Please sign in to comment.