diff --git a/docs/DESCRIBE.md b/docs/DESCRIBE.md index 05d1608a..7e5a0a3f 100644 --- a/docs/DESCRIBE.md +++ b/docs/DESCRIBE.md @@ -49,3 +49,13 @@ 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: +``` + env: + pr_description.use_description_markers: 'true' +``` + + +==> + \ No newline at end of file diff --git a/pics/decsribe_marker_after.png b/pics/decsribe_marker_after.png new file mode 100644 index 00000000..4963a0aa Binary files /dev/null and b/pics/decsribe_marker_after.png differ diff --git a/pics/describe_markers_before.png b/pics/describe_markers_before.png new file mode 100644 index 00000000..66a8b8f0 Binary files /dev/null and b/pics/describe_markers_before.png differ