Fix copilotprovider citations godoc: field is on SessionConfig - #1146
PratikDhanave (PratikDhanave) wants to merge 1 commit into
Conversation
The comment said native citations are enabled via AgentConfig.EnableCitations, but AgentConfig has no such field; the flag lives on AgentConfig.SessionConfig.EnableCitations (the Copilot SDK SessionConfig). Correct the reference.
github-actions
Bot
added
area:provider
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
Comment-only correction accurately reflects the existing AgentConfig.SessionConfig.EnableCitations configuration path.
Review effort: Lite
Findings: None
What changed in this PR
Updates an in-code comment in the Copilot provider to correctly document how native model citations are enabled, aligning the godoc-style guidance with the actual AgentConfig structure used by the provider.
Changes:
- Corrects the comment to reference
AgentConfig.SessionConfig.EnableCitations(rather than a non-existentAgentConfig.EnableCitations). - Improves comment readability by wrapping it across lines.
| File | Description |
|---|---|
| provider/copilotprovider/copilot.go | Fixes comment to accurately describe the configuration field controlling citation surfacing. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
Scope: internal-only (documentation/comment fix) Changed Go contract: None — this PR only corrects a Go comment/godoc string in Upstream evidence reviewed: Not applicable — no upstream comparison is needed since no public API or observable behavior changed. Result: out of scope. This is a comment-only documentation fix with no cross-repo parity implications.
|
Quim Muntal (qmuntal)
left a comment
Quim Muntal (qmuntal)
left a comment
There was a problem hiding this comment.
Thanks. Please don't submit single-line comment changes. Batch all the doc updates into a single PR.
The comment above the citation-surfacing code says native citations are enabled via
AgentConfig.EnableCitations, butAgentConfighas no such field (only the embeddedagent.Config,SessionConfig, andInstructions). The flag actually lives on the Copilot SDKSessionConfig— copied through asEnableCitations: source.EnableCitationswheresourceis a*copilot.SessionConfig. So the setting isAgentConfig.SessionConfig.EnableCitations.Comment-only fix.