From 56f7ae0b4637691886853ba751b2b6a8e802da05 Mon Sep 17 00:00:00 2001 From: mrT23 Date: Sun, 29 Jun 2025 10:37:12 +0300 Subject: [PATCH] docs: add suggestions_depth configuration parameter documentation --- docs/docs/tools/improve.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/docs/docs/tools/improve.md b/docs/docs/tools/improve.md index 05aefa28..bdc83630 100644 --- a/docs/docs/tools/improve.md +++ b/docs/docs/tools/improve.md @@ -437,9 +437,26 @@ dual_publishing_score_threshold = x Where x represents the minimum score threshold (>=) for suggestions to be presented as committable PR comments in addition to the table. Default is -1 (disabled). +### Controlling suggestions depth + +> `💎 feature` + +You can control the depth and comprehensiveness of the code suggestions by using the `pr_code_suggestions.suggestions_depth` parameter. + +Available options: + +- `selective` - Shows only suggestions above a score threshold of 6 +- `regular` - Default mode with balanced suggestion coverage +- `exhaustive` - Provides maximum suggestion comprehensiveness + +(Alternatively, use numeric values: 1, 2, or 3 respectively) + +We recommend starting with `regular` mode, then exploring `exhaustive` mode, which can provide more comprehensive suggestions and enhanced bug detection. + + ### Self-review -> `💎 feature` Platforms supported: GitHub, GitLab +> `💎 feature. Platforms supported: GitHub, GitLab` If you set in a configuration file: @@ -521,6 +538,10 @@ Note: Chunking is primarily relevant for large PRs. For most PRs (up to 600 line enable_chat_in_code_suggestions If set to true, QM bot will interact with comments made on code changes it has proposed. Default is true. + + suggestions_depth 💎 + Controls the depth of the suggestions. Can be set to 'selective', 'regular', or 'exhaustive'. Default is 'regular'. + dual_publishing_score_threshold Minimum score threshold for suggestions to be presented as committable PR comments in addition to the table. Default is -1 (disabled).