diff --git a/docs/DESCRIBE.md b/docs/DESCRIBE.md index 5fa2db65..c3fe7f93 100644 --- a/docs/DESCRIBE.md +++ b/docs/DESCRIBE.md @@ -31,9 +31,6 @@ Under the section 'pr_description', the [configuration file](./../pr_agent/setti 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: ``` User content... @@ -59,4 +56,9 @@ The marker `pr_agent:pr_type` will be replaced with the PR type, `pr_agent:summa ==> - \ No newline at end of file + + +##### Configuration params: + +- `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.