Small doc fixes #6887
Merged
Small doc fixes #6887
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
There was a problem hiding this comment.
Pull Request Overview
This PR fixes various documentation issues across multiple library files, focusing on improving XML documentation comments for better clarity and grammatical consistency.
Key changes:
- Standardizes parameter documentation language patterns (e.g., "The container" instead of "Container")
- Corrects grammatical errors in exception documentation (singular/plural agreement)
- Improves consistency in thread safety warnings
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| FakeRedactionServiceCollectionExtensions.cs | Updates parameter documentation to use "The container" and fixes exception documentation grammar |
| IAsyncState.cs | Changes "may not be" to "might not be" for thread safety warning |
| IAsyncLocalContext.cs | Changes "may not be" to "might not be" for thread safety warning |
| IAsyncContext.cs | Changes "may not be" to "might not be" for thread safety warning |
| ApplicationMetadataServiceCollectionExtensions.cs | Removes extra ">" character from returns documentation |
| ApplicationMetadataConfigurationBuilderExtensions.cs | Improves parameter and returns documentation clarity |
| IEvaluationReportWriter.cs | Simplifies parameter documentation for better clarity |
| HostedMcpServerTool.cs | Fixes subject-verb agreement in exception documentation |
| McpServerToolCallContent.cs | Fixes subject-verb agreement in exception documentation |
...ibraries/Microsoft.Extensions.Compliance.Testing/FakeRedactionServiceCollectionExtensions.cs
Show resolved
Hide resolved
shyamnamboodiripad
approved these changes
Oct 3, 2025
stephentoub
approved these changes
Oct 3, 2025
This was referenced Oct 15, 2025
Merged
This was referenced Oct 15, 2025
Merged
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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