diff --git a/docs/IMPROVE.md b/docs/IMPROVE.md index fcfca54d..f60cec53 100644 --- a/docs/IMPROVE.md +++ b/docs/IMPROVE.md @@ -37,8 +37,9 @@ Under the section 'pr_code_suggestions', the [configuration file](./../pr_agent/ #### A note on code suggestions quality - With current level of AI for code (GPT-4), mistakes can happen. Not all the suggestions will be perfect, and a user should not accept all of them automatically. -Suggestions are not meant to be [simplistic](./../pr_agent/settings/pr_code_suggestions_prompts.toml#L34). Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. -- Recommended to use the 'extra instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project. +- Suggestions are not meant to be [simplistic](./../pr_agent/settings/pr_code_suggestions_prompts.toml#L34). Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. + +- Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project. - Best quality will be obtained by using 'improve --extended' mode. \ No newline at end of file diff --git a/docs/REVIEW.md b/docs/REVIEW.md index f0798e8f..08762252 100644 --- a/docs/REVIEW.md +++ b/docs/REVIEW.md @@ -49,8 +49,9 @@ The tool will first ask the author questions about the PR, and will guide the re #### A note on code suggestions quality - With current level of AI for code (GPT-4), mistakes can happen. Not all the suggestions will be perfect, and a user should not accept all of them automatically. -Suggestions are not meant to be [simplistic](./../pr_agent/settings/pr_reviewer_prompts.toml#L29). Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. -- Recommended to use the 'extra instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project. +- Suggestions are not meant to be [simplistic](./../pr_agent/settings/pr_reviewer_prompts.toml#L29). Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base. + +- Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project. - Unlike the 'review', which does a lot of things, the ['improve --extended'](./IMPROVE.md) feature is dedicated to suggestions, and usually gives better suggestions \ No newline at end of file