Doc updates #6930
Merged
Doc updates #6930
Conversation
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
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR contributes to documentation improvements as part of issue #11392. The changes focus on standardizing terminology and improving clarity in XML documentation comments across the Microsoft.Extensions.AI.Abstractions library.
Key changes:
- Replaced hyphenated "strongly-typed" with "strongly typed" (non-hyphenated) for consistency
- Changed modal verbs from "may/may not" to "might/can" for better technical writing style
- Improved sentence structure and punctuation in documentation comments
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| AITool.cs | Updated "strongly-typed" to "strongly typed" in GetService method documentation |
| SpeechToTextOptions.cs | Updated "strongly-typed" to "strongly typed" in OptionsCallback property documentation |
| AIFunctionFactoryOptions.cs | Updated "strongly-typed" to "strongly typed" in MarshalResult property documentation |
| EmbeddingGenerationOptions.cs | Updated "strongly-typed" to "strongly typed" in OptionsCallback property documentation |
| IChatClient.cs | Updated "strongly-typed" to "strongly typed" in GetService method documentation |
| ChatResponseUpdate.cs | Changed modal verbs from "may" to "might/can" and improved punctuation throughout documentation |
| ChatResponse.cs | Changed modal verbs from "may" to "might/can" and improved sentence structure in documentation |
| ChatOptions.cs | Restructured property documentation using value tags, changed modal verbs, and updated "strongly-typed" to "strongly typed" |
src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatOptions.cs
Show resolved
Hide resolved
src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatResponseUpdate.cs
Show resolved
Hide resolved
src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatResponse.cs
Show resolved
Hide resolved
stephentoub
reviewed
Oct 17, 2025
src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatOptions.cs
Outdated
Show resolved
Hide resolved
gewarren
commented
Oct 20, 2025
src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatOptions.cs
Outdated
Show resolved
Hide resolved
gewarren
commented
Oct 20, 2025
src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatOptions.cs
Outdated
Show resolved
Hide resolved
…ion/ChatOptions.cs Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
…ion/ChatOptions.cs Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
stephentoub
approved these changes
Oct 20, 2025
jeffhandley
pushed a commit
to jeffhandley/extensions
that referenced
this pull request
Oct 21, 2025
* doc updates --------- Co-authored-by: Stephen Toub <stoub@microsoft.com>
jeffhandley
pushed a commit
to jeffhandley/extensions
that referenced
this pull request
Oct 21, 2025
* doc updates --------- Co-authored-by: Stephen Toub <stoub@microsoft.com>
jeffhandley
pushed a commit
to jeffhandley/extensions
that referenced
this pull request
Oct 21, 2025
* doc updates --------- Co-authored-by: Stephen Toub <stoub@microsoft.com>
This was referenced Nov 11, 2025
Merged
Merged
This was referenced Nov 12, 2025
Closed
Merged
Closed
Open
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.
Contributes to dotnet/dotnet-api-docs#11392.
Microsoft Reviewers: Open in CodeFlow