Skip to content

Conversation

gewarren
Copy link
Contributor

@gewarren gewarren commented Sep 10, 2025

Inspired by dotnet/dotnet-api-docs#11792.

Microsoft Reviewers: Open in CodeFlow

@Copilot Copilot AI review requested due to automatic review settings September 10, 2025 04:21
@gewarren gewarren requested review from a team as code owners September 10, 2025 04:21
@github-actions github-actions bot added the area-ai Microsoft.Extensions.AI libraries label Sep 10, 2025
Copy link
Contributor

@Copilot Copilot AI left a comment

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 improves the documentation quality across multiple Microsoft.Extensions.AI library files by updating language for better clarity and consistency.

Key Changes

  • Improved grammar by changing "A" to "An" before "ImageGeneratorBuilder"
  • Updated language from "may" to more definitive terms like "can", "might", or "could"
  • Enhanced clarity in documentation comments and remarks sections

Reviewed Changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated no comments.

Show a summary per file
File Description
ImageGeneratorBuilderServiceCollectionExtensions.cs Updated XML documentation to use "An" instead of "A" before ImageGeneratorBuilder
FunctionInvokingChatClient.cs Improved language clarity changing "may" to "might" and restructuring property documentation
ContentSafetyServiceConfiguration.cs Enhanced documentation formatting and clarity, replaced plain URLs with proper href tags
AIJsonSchemaTransformCache.cs Improved clarity in method parameter documentation
HostedMcpServerTool.cs Changed "may" to "might" for improved clarity
HostedFileSearchTool.cs Updated language from "may" to "might/can" and improved sentence structure
ImageGeneratorExtensions.cs Updated class summary and fixed grammar in exception documentation
ImageGenerationResponse.cs Restructured property documentation into summary and remarks sections
ImageGenerationOptions.cs Improved language clarity throughout documentation
HostedMcpServerToolApprovalMode.cs Enhanced parameter documentation clarity
AIFunctionFactory.cs Comprehensive language improvements changing "may" to "can" throughout
AIFunctionDeclaration.cs Updated language from "may" to "can" in remarks
CitationAnnotation.cs Improved clarity in property documentation

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@stephentoub stephentoub enabled auto-merge (squash) September 10, 2025 17:14
@stephentoub stephentoub merged commit 902b6f7 into main Sep 10, 2025
6 checks passed
@stephentoub stephentoub deleted the docs-0925 branch September 10, 2025 17:48
@github-actions github-actions bot locked and limited conversation to collaborators Oct 11, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-ai Microsoft.Extensions.AI libraries

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants