diff --git a/docs/docs/tools/improve.md b/docs/docs/tools/improve.md index 3bd748c07..1ae903b38 100644 --- a/docs/docs/tools/improve.md +++ b/docs/docs/tools/improve.md @@ -167,75 +167,75 @@ Using a combination of both can help the AI model to provide relevant and tailor ## Configuration options -!!! example "General options" - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
num_code_suggestionsNumber of code suggestions provided by the 'improve' tool. Default is 4 for CLI, 0 for auto tools.
extra_instructionsOptional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
rank_suggestionsIf set to true, the tool will rank the suggestions, based on importance. Default is false.
commitable_code_suggestionsIf set to true, the tool will display the suggestions as commitable code comments. Default is false.
persistent_commentIf set to true, the improve comment will be persistent, meaning that every new improve request will edit the previous one. Default is false.
self_reflect_on_suggestionsIf set to true, the improve tool will calculate an importance score for each suggestion [1-10], and sort the suggestion labels group based on this score. Default is true.
suggestions_score_threshold Any suggestion with importance score less than this threshold will be removed. Default is 0. Highly recommend not to set this value above 7-8, since above it may clip relevant suggestions that can be useful.
apply_suggestions_checkbox Enable the checkbox to create a committable suggestion. Default is true.
enable_help_textIf set to true, the tool will display a help text in the comment. Default is true.
enable_chat_textIf set to true, the tool will display a reference to the PR chat in the comment. Default is true.
- -!!! example "params for 'extended' mode" - - - - - - - - - - - - - - - - - - - - - - -
auto_extended_modeEnable extended mode automatically (no need for the --extended option). Default is true.
num_code_suggestions_per_chunkNumber of code suggestions provided by the 'improve' tool, per chunk. Default is 5.
rank_extended_suggestionsIf set to true, the tool will rank the suggestions, based on importance. Default is true.
max_number_of_callsMaximum number of chunks. Default is 5.
final_clip_factorFactor to remove suggestions with low confidence. Default is 0.9.
+??? example "General options" + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
num_code_suggestionsNumber of code suggestions provided by the 'improve' tool. Default is 4 for CLI, 0 for auto tools.
extra_instructionsOptional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...".
rank_suggestionsIf set to true, the tool will rank the suggestions, based on importance. Default is false.
commitable_code_suggestionsIf set to true, the tool will display the suggestions as commitable code comments. Default is false.
persistent_commentIf set to true, the improve comment will be persistent, meaning that every new improve request will edit the previous one. Default is false.
self_reflect_on_suggestionsIf set to true, the improve tool will calculate an importance score for each suggestion [1-10], and sort the suggestion labels group based on this score. Default is true.
suggestions_score_threshold Any suggestion with importance score less than this threshold will be removed. Default is 0. Highly recommend not to set this value above 7-8, since above it may clip relevant suggestions that can be useful.
apply_suggestions_checkbox Enable the checkbox to create a committable suggestion. Default is true.
enable_help_textIf set to true, the tool will display a help text in the comment. Default is true.
enable_chat_textIf set to true, the tool will display a reference to the PR chat in the comment. Default is true.
+ +??? example "params for 'extended' mode" + + + + + + + + + + + + + + + + + + + + + + +
auto_extended_modeEnable extended mode automatically (no need for the --extended option). Default is true.
num_code_suggestions_per_chunkNumber of code suggestions provided by the 'improve' tool, per chunk. Default is 5.
rank_extended_suggestionsIf set to true, the tool will rank the suggestions, based on importance. Default is true.
max_number_of_callsMaximum number of chunks. Default is 5.
final_clip_factorFactor to remove suggestions with low confidence. Default is 0.9.
## A note on code suggestions quality