Skip to content

Fix loop.Config.MaxIterations godoc: no exported DefaultMaxIterations - #1151

Open
PratikDhanave (PratikDhanave) wants to merge 1 commit into
microsoft:mainfrom
PratikDhanaveFork:fix/godoc-loop-maxiterations
Open

PratikDhanave (PratikDhanave) wants to merge 1 commit into
microsoft:mainfrom
PratikDhanaveFork:fix/godoc-loop-maxiterations

Conversation

@PratikDhanave

Copy link
Copy Markdown
Contributor

The MaxIterations comment says "When nil, DefaultMaxIterations is used," but there is no exported DefaultMaxIterations symbol — the only constant is the unexported defaultMaxIterations = 10. State the default (10) directly. Comment-only fix.

The comment referenced DefaultMaxIterations, which does not exist; the only
constant is the unexported defaultMaxIterations = 10. State the default value
directly.
Copilot AI lite review requested due to automatic review settings September 22, 2026 03:13
@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 22, 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.

Copilot review overview

🟢 Approval recommended

The documentation-only change resolves the inaccurate symbol reference.

Review effort: Lite
Findings: None

What changed in this PR

Corrects the MaxIterations GoDoc to state the actual default value.

Changes:

  • Replaces the nonexistent DefaultMaxIterations reference with 10 iterations.
File Description
agent/​harness/​loop/​loop.go Corrects MaxIterations documentation.

💡 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/comment-only change)

Changed Go contract: None. The change only edits a godoc comment on loop.Config.MaxIterations (agent/harness/loop/loop.go), replacing a reference to a non-existent exported DefaultMaxIterations symbol with the literal default value 10. No exported identifiers, types, options, defaults, or runtime behavior are added, removed, or changed.

Upstream evidence reviewed: Not applicable — no exported API or observable behavior changed, so no upstream .NET/Python comparison is warranted.

Result: out of scope. This is a comment-only correctness fix with no cross-repo parity implications.

Generated by Go API Consistency Review Agent · copilot · auto · 20.5 AIC · ⌖ 4.8 AIC · ⊞ 9.2K · ◷

@github-actions github-actions Bot added the kind:docs Changes documentation or comments label Sep 22, 2026
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.

2 participants