Doc updates #64092
Open
Doc updates #64092
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 pull request updates XML documentation comments across several files to align with .NET API documentation standards. The changes primarily involve clarifying language, improving consistency, and adding proper structure to documentation.
Key changes:
- Restructured documentation by moving default values from summary sections to dedicated
<value>tags and explanatory details to<remarks>sections - Standardized language patterns (e.g., "Provides" → "Specifies", "which" → "that", "Checks if" → "Gets a value that indicates whether")
- Enhanced documentation clarity by using
<see langword="..." />tags for boolean/null values instead of plain text
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 |
|---|---|
| src/Validation/src/ValidationOptions.cs | Restructured documentation for MaxDepth property and updated XML doc comments to use <see langword> tags for boolean/null values |
| src/Validation/src/ValidateContext.cs | Added code language attribute to example and reorganized documentation by moving remarks to dedicated sections |
| src/Validation/src/SkipValidationAttribute.cs | Moved attribute usage details from summary to remarks section |
| src/Validation/src/IValidatableInfoResolver.cs | Standardized parameter documentation and added <see langword> tags for boolean values |
| src/Logging.AzureAppServices/src/FileLoggerProvider.cs | Updated class and parameter descriptions for consistency |
| src/Logging.AzureAppServices/src/BatchingLoggerProvider.cs | Standardized documentation language patterns |
| src/Logging.AzureAppServices/src/BatchingLoggerOptions.cs | Restructured property documentation with <value> and <remarks> sections |
| src/Logging.AzureAppServices/src/AzureFileLoggerOptions.cs | Added <value> and <remarks> sections for property documentation |
| src/Logging.AzureAppServices/src/AzureBlobLoggerOptions.cs | Restructured property documentation with <value> sections |
| src/Logging.AzureAppServices/src/AzureBlobLoggerContext.cs | Updated property documentation to use "Gets" pattern |
| src/Logging.AzureAppServices/src/AzureAppServicesLoggerFactoryExtensions.cs | Standardized class and parameter descriptions |
| src/HttpClientFactory/Polly/src/DependencyInjection/PollyHttpClientBuilderExtensions.cs | Standardized "which" to "that" and improved punctuation |
| src/Caching/SqlServer/src/SqlServerCacheOptions.cs | Added <value> sections and standardized property documentation |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Doc updates for APIs published under .NET monikers.
Contributes to dotnet/dotnet-api-docs#11392.