docs(engines): clarify model field comment as override example#22819
Merged
docs(engines): clarify model field comment as override example#22819
Conversation
…xample Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com> Agent-Logs-Url: https://github.com/github/gh-aw/sessions/b92ebe54-5e33-4f38-81b5-b9b0089df84c
Copilot
AI
changed the title
[WIP] Fix model field example/comment mismatch in docs
docs(engines): clarify model field comment as override example
Mar 25, 2026
pelikhan
approved these changes
Mar 25, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Clarifies the intent of the model field comment in the “Extended Coding Agent Configuration” example so it’s unambiguously an override example rather than a statement about the default model.
Changes:
- Updated the inline YAML comment for
engine.modelto indicate it’s an example override and that omitting it uses the engine default.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
modelfield in the "Extended Coding Agent Configuration" example had a value/comment mismatch —model: gpt-5paired with# defaults to claude-sonnet-4simultaneously demonstrated an override and claimed to document the default, making the intent ambiguous.Change
Updated the comment to make the intent explicit:
🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.