Visitar URL original
Doc updates by gewarren · Pull Request #6930 · dotnet/extensions · GitHub
Skip to content

Doc updates - #6930

Merged
stephentoub merged 4 commits into
mainfrom
docs101725
Oct 20, 2025
Merged

Doc updates#6930
stephentoub merged 4 commits into
mainfrom
docs101725

Conversation

@gewarren

@gewarren gewarren commented Oct 17, 2025 •
edited by dotnet-policy-service Bot
Loading

Copy link
Copy Markdown
Contributor

Contributes to dotnet/dotnet-api-docs#11392.

Microsoft Reviewers: Open in CodeFlow

@gewarren
gewarren requested a review from a team as a code owner October 17, 2025 17:04
@gewarren
gewarren requested review from Copilot and removed request for a team October 17, 2025 17:04
@github-actions github-actions Bot added the area-ai Microsoft.Extensions.AI libraries label Oct 17, 2025
Copilot AI reviewed Oct 17, 2025
View reviewed changes

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.

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"

Comment thread src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatOptions.cs Resolved
Comment thread src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatResponseUpdate.cs Resolved
Comment thread src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatResponse.cs Resolved
stephentoub
stephentoub reviewed Oct 17, 2025
View reviewed changes
Comment thread src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatOptions.cs Resolved
gewarren
gewarren commented Oct 20, 2025
View reviewed changes
Comment thread src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatOptions.cs Resolved
gewarren
gewarren commented Oct 20, 2025
View reviewed changes
Comment thread src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatCompletion/ChatOptions.cs Resolved
stephentoub and others added 2 commits October 20, 2025 19:07
@stephentoub @gewarren
Update src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatComplet…
e587226 
…ion/ChatOptions.cs

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
@stephentoub @gewarren
Update src/Libraries/Microsoft.Extensions.AI.Abstractions/ChatComplet…
308e729 
…ion/ChatOptions.cs

Co-authored-by: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
@stephentoub
stephentoub enabled auto-merge (squash) October 20, 2025 23:08
@stephentoub
stephentoub merged commit 0947207 into main Oct 20, 2025
@stephentoub
stephentoub deleted the docs101725 branch October 20, 2025 23:42
jeffhandley pushed a commit to jeffhandley/extensions that referenced this pull request Oct 21, 2025
@gewarren @stephentoub @jeffhandley
Doc updates (dotnet#6930)
fad6df5 
* doc updates

---------

Co-authored-by: Stephen Toub <stoub@microsoft.com>
@jeffhandley jeffhandley mentioned this pull request Oct 21, 2025
Merged
jeffhandley pushed a commit to jeffhandley/extensions that referenced this pull request Oct 21, 2025
@gewarren @stephentoub @jeffhandley
Doc updates (dotnet#6930)
29d6926 
* 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
@gewarren @stephentoub @jeffhandley
Doc updates (dotnet#6930)
c6ed27c 
* doc updates

---------

Co-authored-by: Stephen Toub <stoub@microsoft.com>
This was referenced Nov 11, 2025
Closed
Merged
Merged
Merged
Merged
Closed
Merged
Merged
Merged
This was referenced Nov 19, 2025
Merged
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
Closed
@github-actions github-actions Bot locked and limited conversation to collaborators Nov 20, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@stephentoub stephentoub stephentoub approved these changes

Assignees

@gewarren gewarren

Labels

area-ai Microsoft.Extensions.AI libraries

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@gewarren @stephentoub