diff --git a/docs/docs/tools/describe.md b/docs/docs/tools/describe.md index b92dae30..33c96e96 100644 --- a/docs/docs/tools/describe.md +++ b/docs/docs/tools/describe.md @@ -9,13 +9,13 @@ For example: - + - + @@ -33,7 +33,7 @@ To edit [configurations](https://github.com/Codium-ai/pr-agent/blob/main/pr_agen - `publish_labels`: if set to true, the tool will publish the labels to the PR. Default is true. - - `publish_description_as_comment`: if set to true, the tool will publish the description as a comment to the PR. If false, it will overwrite the origianl description. Default is false. + - `publish_description_as_comment`: if 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. - `add_original_user_description`: if set to true, the tool will add the original user description to the generated description. Default is true. @@ -58,7 +58,7 @@ To copy the `changes walkthrough` table to the "Files changed" tab, you can clic - + @@ -68,7 +68,7 @@ If you prefer to have the file summaries appear in the "Files changed" tab on ev - + @@ -76,7 +76,7 @@ If you prefer to have the file summaries appear in the "Files changed" tab on ev - + @@ -99,8 +99,8 @@ Now add/edit the custom labels. they should be formatted as follows: The description should be comprehensive and detailed, indicating when to add the desired label. For example: - - + + @@ -127,7 +127,7 @@ The marker `pr_agent:type` will be replaced with the PR type, `pr_agent:summary` - + @@ -135,7 +135,7 @@ The marker `pr_agent:type` will be replaced with the PR type, `pr_agent:summary` - +