From 19f85f08b044763e1dea0e91a691ae63df2afc5c Mon Sep 17 00:00:00 2001 From: mrT23 Date: Sun, 7 Jan 2024 11:29:07 +0200 Subject: [PATCH] docs: Enhance 'improve' tool documentation and update 'DESCRIBE.md' with hyperlink --- docs/IMPROVE.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/IMPROVE.md b/docs/IMPROVE.md index afa66789..95059f40 100644 --- a/docs/IMPROVE.md +++ b/docs/IMPROVE.md @@ -35,11 +35,12 @@ Hence, the total number of suggestions is proportional to the number of chunks, ### Configuration options -To edit [configurations](./../pr_agent/settings/configuration.toml#L46) related to the improve tool (`pr_code_suggestions` section), use the following template: +To edit [configurations](./../pr_agent/settings/configuration.toml#L66) related to the improve tool (`pr_code_suggestions` section), use the following template: ``` /improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=... ``` +#### General options - `num_code_suggestions`: number of code suggestions provided by the 'improve' tool. Default is 4. - `extra_instructions`: Optional extra instructions to the tool. For example: "focus on the changes in the file X. Ignore change in ...". - `rank_suggestions`: if set to true, the tool will rank the suggestions, based on importance. Default is false. @@ -52,7 +53,7 @@ To edit [configurations](./../pr_agent/settings/configuration.toml#L46) related - `max_number_of_calls`: maximum number of chunks. Default is 5. - `final_clip_factor`: factor to remove suggestions with low confidence. Default is 0.9. -### Summarize mode +#### Summarize mode In this mode, instead of presenting committable suggestions, the different suggestions will be combined into a single compact comment, with significantly smaller PR footprint. To invoke the summarize mode, use the following command: