diff --git a/docs/DESCRIBE.md b/docs/DESCRIBE.md index d58804e2..5fa2db65 100644 --- a/docs/DESCRIBE.md +++ b/docs/DESCRIBE.md @@ -27,11 +27,12 @@ Under the section 'pr_description', the [configuration file](./../pr_agent/setti - `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...". -#### Markers template +### Markers template markers enable to easily integrate user's content and auto-generated content, with a template-like mechanism. - `use_description_markers`: if set to true, the tool will use markers template. It replaces every marker of the form `pr_agent:marker_name` with the relevant content. Default is false. +- `include_generated_by_header`: if set to true, the tool will add a dedicated header: 'Generated by PR Agent at ...' to any automatic content. Default is true. For example, if the PR original description was: ``` @@ -48,9 +49,7 @@ pr_agent:walkthrough ``` The marker `pr_agent:pr_type` will be replaced with the PR type, `pr_agent:summary` will be replaced with the PR summary, and `pr_agent:walkthrough` will be replaced with the PR walkthrough. -- `include_generated_by_header`: if set to true, the tool will add a dedicated header: 'Generated by PR Agent at ...' to any automatic content. Default is true. - -##### Example usage: +##### Example: ``` env: pr_description.use_description_markers: 'true' diff --git a/pics/describe_markers_after.png b/pics/describe_markers_after.png index 4963a0aa..bc9fd5d9 100644 Binary files a/pics/describe_markers_after.png and b/pics/describe_markers_after.png differ