diff --git a/docs/IMPROVE.md b/docs/IMPROVE.md index bd94f52d..2d0f8751 100644 --- a/docs/IMPROVE.md +++ b/docs/IMPROVE.md @@ -16,16 +16,18 @@ The tool can be triggered automatically every time a new PR is [opened](https:// /improve ``` -The suggestions can appear as a collapsible comment (pr_code_suggestions.summarize=true): +### Summarized vs commitable code suggestions + +The code suggestions can appear as a single comment (`pr_code_suggestions.summarize=true`): -Or as a separate commitable comment for each suggestion: +Or as a separate commitable code comment for each suggestion: --- -Note that a collapsible comment has a significantly smaller PR footprint. +Note that a single comment has a significantly smaller PR footprint. We recommend this mode for most cases. ### Extended mode