Remove unnecessary description tags #7226
Merged
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
Member
|
Are these also unnecessary for VS / IntelliSense consuming these XML docs from nuget packages? |
stephentoub
reviewed
Jan 23, 2026
src/Libraries/Microsoft.Extensions.AI.Abstractions/Functions/AIFunctionFactory.cs
Show resolved
Hide resolved
Contributor
Author
Yes, it was just a bug in Learn that the bullets only rendered with description tags. For longer story, see dotnet/roslyn#81895. |
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request removes unnecessary <description> tags from XML documentation comments within bullet list <item> elements, following a bug fix in the Microsoft Learn platform that no longer requires these tags.
Changes:
- Updated XML documentation in Telemetry Abstractions libraries (metrics attributes, logging attributes, HTTP metadata)
- Updated XML documentation in Resilience library (service collection extensions)
- Updated XML documentation in AI Abstractions library (function factory methods)
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Metrics/HistogramAttributeT.cs | Removed <description> tags from 5 bullet items describing method constraints |
| src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Metrics/HistogramAttribute.cs | Removed <description> tags from 5 bullet items describing method constraints |
| src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Metrics/GaugeAttribute.cs | Removed <description> tags from 5 bullet items describing method constraints |
| src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Metrics/CounterAttributeT.cs | Removed <description> tags from 5 bullet items describing method constraints |
| src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Metrics/CounterAttribute.cs | Removed <description> tags from 5 bullet items describing method constraints |
| src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Logging/TagProviderAttribute.cs | Removed <description> tags from 2 bullet items describing method parameter requirements |
| src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Http/RequestMetadata.cs | Removed <description> tags from multiple bullet items across 3 property documentation sections |
| src/Libraries/Microsoft.Extensions.Resilience/Resilience/ResilienceServiceCollectionExtensions.cs | Removed <description> tags from 2 bullet items describing enrichment features |
| src/Libraries/Microsoft.Extensions.AI.Abstractions/Functions/AIFunctionFactory.cs | Removed <description> tags from bullet items across 5 method overloads documenting parameter binding behavior |
stephentoub
approved these changes
Jan 23, 2026
This was referenced Feb 11, 2026
Merged
Bump Microsoft.Extensions.ServiceDiscovery from 10.2.0 to 10.3.0
askpt/openfeature-aspire-sample#351
Merged
Open
chore: Bump Microsoft.Extensions.ServiceDiscovery from 10.2.0 to 10.3.0
JerrettDavis/PokManagerUI#23
Open
This was referenced Feb 11, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Learn platform fixed a bug such that <description> tags within bullet list <item> elements are no longer necessary. See https://ceapex.visualstudio.com/Engineering/_workitems/edit/1122283/.
Microsoft Reviewers: Open in CodeFlow