-
Notifications
You must be signed in to change notification settings - Fork 839
Doc improvements #6794
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Doc improvements #6794
Conversation
There was a problem hiding this 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.
Inspired by dotnet/dotnet-api-docs#11792.
Microsoft Reviewers: Open in CodeFlow