From 7810ba7d76b47f9dd0bedfe1ec7a89cd21a8a4b3 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Sun, 7 Jan 2024 09:40:24 +0200 Subject: [PATCH] docs: Reorganize and enhance documentation for review and describe tools --- docs/REVIEW.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/REVIEW.md b/docs/REVIEW.md index da9ce67d..4b6e1c9b 100644 --- a/docs/REVIEW.md +++ b/docs/REVIEW.md @@ -130,14 +130,14 @@ Be specific, clear, and concise in the instructions. With extra instructions, yo Examples for extra instructions: ``` -pr_commands = ['/review --pr_reviewer.extra_instructions=""" +[pr_reviewer] # /review # +extra_instructions=""" In the code feedback section, emphasize the following: - Does the code logic covers relevant edge cases? - Is the code logic clear and easy to understand? - Is the code logic efficient? ... -"""\ -'] +""" ``` Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.