Skip to content

Commit fc1b757

Browse files
committed
docs: enhance explanation of table vs committable code comments in Qodo Merge
1 parent 3fd8210 commit fc1b757

File tree

1 file changed

+20
-19
lines changed

1 file changed

+20
-19
lines changed

docs/docs/tools/improve.md

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -24,25 +24,6 @@ ___
2424

2525
## Example usage
2626

27-
### Table vs Committable code comments
28-
29-
Qodo Merge supports two modes for presenting code suggestions:
30-
31-
1) [Table](https://codium.ai/images/pr_agent/code_suggestions_as_comment_closed.png) mode
32-
33-
2) [Committable](https://codium.ai/images/pr_agent/improve.png) code comments mode.
34-
35-
36-
37-
Both modes are useful and depend on your preferences and workflow. We recommend using table mode, since it provides the following advantages:
38-
39-
- The table format creates significantly less noise in the PR
40-
- It enables quick review of one-liner summaries, severity levels, and easy prioritization of important suggestions
41-
- High-level suggestions that aren't tied to specific code chunks are presented only in the table mode
42-
- The table provides 'more' and 'update' functionality through clickable buttons
43-
- The table makes it easy to track in a single place which suggestions have already been applied
44-
- Suggestion from the table can be applied in your IDE environment via [Qodo Command](https://github.com/qodo-ai/agents)
45-
4627
### Manual triggering
4728

4829
Invoke the tool manually by commenting `/improve` on any PR. The code suggestions by default are presented as a single comment:
@@ -88,6 +69,26 @@ num_code_suggestions_per_chunk = ...
8869
- The `pr_commands` lists commands that will be executed automatically when a PR is opened.
8970
- The `[pr_code_suggestions]` section contains the configurations for the `improve` tool you want to edit (if any)
9071

72+
### Table vs Committable code comments
73+
74+
Qodo Merge supports two modes for presenting code suggestions:
75+
76+
1) [Table](https://codium.ai/images/pr_agent/code_suggestions_as_comment_closed.png) mode
77+
78+
2) [Inline Committable](https://codium.ai/images/pr_agent/improve.png) code comments mode.
79+
80+
The table format offers several key advantages:
81+
82+
- **Reduced noise**: Creates a cleaner PR experience with less clutter
83+
- **Quick overview and prioritization**: Enables quick review of one-liner summaries, severity levels, and easy prioritization
84+
- **High-level suggestions**: High-level suggestions that aren't tied to specific code chunks are presented only in the table mode
85+
- **Interactive features**: Provides 'more' and 'update' functionality via clickable buttons
86+
- **Centralized tracking**: Shows suggestion implementation status in one place
87+
- **IDE integration**: Allows direct application in your IDE via [Qodo Command](https://github.com/qodo-ai/agents)
88+
89+
Table mode is the default of Qodo Merge, and is recommended approach for most users due to these benefits.
90+
Teams with specific preferences can enable committable code comments mode in their local configuration, or use [dual publishing mode](#dual-publishing-mode).
91+
9192
### Assessing Impact
9293

9394
>`💎 feature`

0 commit comments

Comments
 (0)