Skip to content

Fix DefaultToolCallFormatter godoc: it groups repeated names, not counts - #1086

Merged
Quim Muntal (qmuntal) merged 1 commit into
microsoft:mainfrom
PratikDhanaveFork:compaction-formatter-godoc
Sep 16, 2026
Merged

Quim Muntal (qmuntal) merged 1 commit into
microsoft:mainfrom
PratikDhanaveFork:compaction-formatter-godoc

Conversation

@PratikDhanave

Copy link
Copy Markdown
Contributor

DefaultToolCallFormatter (agent/compaction/toolresult.go) doc says its output includes "tool names, results, and deduplication counts for repeated tool names".

The function emits no numeric counts: it lists each tool name once (orderedNames) with its results grouped beneath on - <result> lines (e.g. [Tool Calls]\nsearch:\n - found 3 docs). Corrected the comment to describe the grouping instead of non-existent counts. Doc-only change.

The comment claimed the output includes 'deduplication counts for repeated tool
names', but the formatter emits no numeric counts - it lists each tool name once
with its results grouped on '  - <result>' lines. Corrected the description.
Copilot AI lite review requested due to automatic review settings September 16, 2026 07:44
@github-actions github-actions Bot added area:agent Changes files in the agent area size:small At most 30 changed lines across at most 2 files labels Sep 16, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

Documentation-only correction with no unresolved issues.

Pull request overview

Updates DefaultToolCallFormatter documentation to accurately describe grouped tool results rather than numeric counts.

Changes:

  • Clarifies that each tool name appears once.
  • Documents grouped results beneath each tool name.
File summaries
File Description
agent/compaction/toolresult.go Corrected formatter documentation.
Review details
  • Files reviewed: 1/1 changed files
  • Comments generated: 0
  • Review effort level: Lite

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@github-actions

Copy link
Copy Markdown
Contributor

Scope: internal-only (documentation)
Changed Go contract: None — only the godoc comment on DefaultToolCallFormatter (agent/compaction/toolresult.go) was edited to accurately describe existing behavior (grouping repeated tool names instead of claiming non-existent deduplication counts). No exported signature, type, default, or runtime behavior changed.
Upstream evidence reviewed: Not applicable — no Go code, defaults, or behavior changed, so there is no cross-repo contract to compare against .NET (dotnet/src/Microsoft.Agents.AI/) or Python (python/packages/core/agent_framework/).
Result: out of scope for parity review (doc-only fix, no public API or behavior change).

No public-api-change label needed since no exported API surface was added, removed, or altered.

Generated by Go API Consistency Review Agent · copilot · auto · 12.5 AIC · ⌖ 6.07 AIC · ⊞ 9.6K ·

@github-actions github-actions Bot added the kind:docs Changes documentation or comments label Sep 16, 2026
@qmuntal
Quim Muntal (qmuntal) added this pull request to the merge queue Sep 16, 2026
Merged via the queue into microsoft:main with commit e245ec3 Sep 16, 2026
28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:agent Changes files in the agent area kind:docs Changes documentation or comments size:small At most 30 changed lines across at most 2 files

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants