Fix up docs with Copilot (MEAI)#7600
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refines XML documentation across the Microsoft.Extensions.AI libraries to improve consistency and readability (moving long explanations into <remarks> / <value>, standardizing property wording, and adjusting phrasing).
Changes:
- Moved extended explanatory text out of
<summary>into<remarks>/<value>for clearer API docs. - Standardized init-only property docs to use “Gets or initializes …” and aligned “value that indicates …” phrasing.
- Clarified examples and custom attribute references in realtime and OpenTelemetry-related constants/docs.
Reviewed changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/Libraries/Microsoft.Extensions.AI/OpenTelemetryConsts.cs | Reworked GenAI realtime operation docs into <remarks> and standardized wording. |
| src/Libraries/Microsoft.Extensions.AI/ChatCompletion/FunctionInvocationContext.cs | Adjusted property phrasing for consistency (“value that indicates …”). |
| src/Libraries/Microsoft.Extensions.AI.Abstractions/Utilities/AIJsonSchemaTransformOptions.cs | Standardized init-only property docs (“Gets or initializes …”). |
| src/Libraries/Microsoft.Extensions.AI.Abstractions/Utilities/AIJsonSchemaTransformContext.cs | Updated boolean property summaries for consistent phrasing. |
| src/Libraries/Microsoft.Extensions.AI.Abstractions/Utilities/AIJsonSchemaCreateOptions.cs | Standardized init-only property docs and related summaries. |
| src/Libraries/Microsoft.Extensions.AI.Abstractions/Tools/HostedMcpServerTool.cs | Moved extended ServerAddress explanation into <remarks>. |
| src/Libraries/Microsoft.Extensions.AI.Abstractions/Realtime/ResponseCreatedRealtimeServerMessage.cs | Improved property docs using <value> for null semantics and clearer examples. |
| src/Libraries/Microsoft.Extensions.AI.Abstractions/Realtime/RealtimeSessionOptions.cs | Standardized multiple init-only property docs and adjusted OutputModalities documentation. |
| src/Libraries/Microsoft.Extensions.AI.Abstractions/Realtime/RealtimeServerMessage.cs | Moved correlation detail into <remarks>. |
| src/Libraries/Microsoft.Extensions.AI.Abstractions/Realtime/RealtimeConversationItem.cs | Moved extended explanation of RawRepresentation into <remarks>. |
| src/Libraries/Microsoft.Extensions.AI.Abstractions/Realtime/RealtimeClientMessage.cs | Moved correlation detail into <remarks>. |
| src/Libraries/Microsoft.Extensions.AI.Abstractions/Realtime/RealtimeAudioFormat.cs | Standardized init-only property docs (“Gets or initializes …”). |
| src/Libraries/Microsoft.Extensions.AI.Abstractions/Contents/ToolApprovalResponseContent.cs | Adjusted boolean property phrasing for consistency. |
| src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatToolMode.cs | Moved a requirement statement into <remarks> for cleaner summary text. |
gewarren
commented
Jul 6, 2026
Collaborator
🎉 Good job! The coverage increased 🎉
Full code coverage report: https://dev.azure.com/dnceng-public/public/_build/results?buildId=1495550&view=codecoverage-tab |
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.
Microsoft Reviewers: Open in CodeFlow