From 7178ddac10bf1ef5bd8cc846537579420d414dc6 Mon Sep 17 00:00:00 2001 From: Tal Date: Sun, 21 Jan 2024 17:31:33 +0200 Subject: [PATCH] Update CUSTOM_SUGGESTIONS.md --- docs/CUSTOM_SUGGESTIONS.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/CUSTOM_SUGGESTIONS.md b/docs/CUSTOM_SUGGESTIONS.md index e6756b42..c8123d34 100644 --- a/docs/CUSTOM_SUGGESTIONS.md +++ b/docs/CUSTOM_SUGGESTIONS.md @@ -8,7 +8,7 @@ ## Overview The `custom_suggestions` tool scans the PR code changes, and automatically generates custom suggestions for improving the PR code. -It shares similarities with the `improve` tool, but with one main difference: the `custom_suggestions` tool will only propose suggestion that follow specific guidelines defined by the prompt in: `pr_custom_suggestions.prompt` configuration. +It shares similarities with the `improve` tool, but with one main difference: the `custom_suggestions` tool will only propose suggestions that follow specific guidelines defined by the prompt in: `pr_custom_suggestions.prompt` configuration. The tool can be triggered [automatically](https://github.com/Codium-ai/pr-agent/blob/main/Usage.md#github-app-automatic-tools) every time a new PR is opened, or can be invoked manually by commenting on a PR. @@ -36,7 +36,7 @@ You might benefit from several trial-and-error iterations, until you get the cor ## Example usage -Here is an example for a possible prompt: +Here is an example of a possible prompt: ``` [pr_custom_suggestions] prompt="""\ @@ -58,8 +58,8 @@ ___ ## Configuration options -`prompt`: the prompt for the tool. Should be a multi-line string. +`prompt`: the prompt for the tool. It should be a multi-line string. `num_code_suggestions`: number of code suggestions provided by the 'custom_suggestions' tool. Default is 4. -`enable_help_text`: if set to true, the tool will display a help text in the comment. Default is true. \ No newline at end of file +`enable_help_text`: if set to true, the tool will display a help text in the comment. Default is true.