Skip to content

Remove unnecessary description tags #7226

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.

Sign up for GitHub

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

Merged
gewarren merged 2 commits into from
Jan 24, 2026
Merged

Remove unnecessary description tags #7226

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0a04891
remove unnecessary description tags
gewarren Jan 23, 2026
b5b6f6a
fix indentation
gewarren Jan 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
remove unnecessary description tags
  • Loading branch information
@gewarren
gewarren committed Jan 23, 2026
commit 0a04891a6ad41baf547621547369f8938021a9d3
60 changes: 15 additions & 45 deletions src/Libraries/Microsoft.Extensions.AI.Abstractions/Functions/AIFunctionFactory.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,30 +48,24 @@ public static partial class AIFunctionFactory
/// <see cref="AIFunctionDeclaration.JsonSchema"/>. There are a few exceptions to this:
/// <list type="bullet">
/// <item>
/// <description>
/// <see cref="CancellationToken"/> parameters are automatically bound to the <see cref="CancellationToken"/> passed into
/// <see cref="CancellationToken"/> parameters are automatically bound to the <see cref="CancellationToken"/> passed into
/// the invocation via <see cref="AIFunction.InvokeAsync"/>'s <see cref="CancellationToken"/> parameter. The parameter is
/// not included in the generated JSON schema. The behavior of <see cref="CancellationToken"/> parameters can't be overridden.
/// </description>
/// </item>
/// <item>
/// <description>
/// By default, <see cref="IServiceProvider"/> parameters are bound from the <see cref="AIFunctionArguments.Services"/> property
/// By default, <see cref="IServiceProvider"/> parameters are bound from the <see cref="AIFunctionArguments.Services"/> property
/// and are not included in the JSON schema. If the parameter is optional, such that a default value is provided,
/// <see cref="AIFunctionArguments.Services"/> is allowed to be <see langword="null"/>; otherwise, <see cref="AIFunctionArguments.Services"/>
/// must be non-<see langword="null"/>, or else the invocation will fail with an exception due to the required nature of the parameter.
/// The handling of <see cref="IServiceProvider"/> parameters can be overridden via <see cref="AIFunctionFactoryOptions.ConfigureParameterBinding"/>.
/// </description>
/// </item>
/// <item>
/// <description>
/// By default, <see cref="AIFunctionArguments"/> parameters are bound directly to <see cref="AIFunctionArguments"/> instance
/// By default, <see cref="AIFunctionArguments"/> parameters are bound directly to <see cref="AIFunctionArguments"/> instance
/// passed into <see cref="AIFunction.InvokeAsync"/> and are not included in the JSON schema. If the <see cref="AIFunctionArguments"/>
/// instance passed to <see cref="AIFunction.InvokeAsync"/> is <see langword="null"/>, the <see cref="AIFunction"/> implementation
/// manufactures an empty instance, such that parameters of type <see cref="AIFunctionArguments"/> can always be satisfied, whether
/// optional or not. The handling of <see cref="AIFunctionArguments"/> parameters can be overridden via
/// <see cref="AIFunctionFactoryOptions.ConfigureParameterBinding"/>.
/// </description>
/// </item>
/// </list>
/// All other parameter types are, by default, bound from the <see cref="AIFunctionArguments"/> dictionary passed into <see cref="AIFunction.InvokeAsync"/>
Expand Down Expand Up @@ -135,28 +129,22 @@ public static AIFunction Create(Delegate method, AIFunctionFactoryOptions? optio
/// <see cref="AIFunctionDeclaration.JsonSchema"/>. There are a few exceptions to this:
/// <list type="bullet">
/// <item>
/// <description>
/// <see cref="CancellationToken"/> parameters are automatically bound to the <see cref="CancellationToken"/> passed into
/// <see cref="CancellationToken"/> parameters are automatically bound to the <see cref="CancellationToken"/> passed into
/// the invocation via <see cref="AIFunction.InvokeAsync"/>'s <see cref="CancellationToken"/> parameter. The parameter is
/// not included in the generated JSON schema.
/// </description>
/// </item>
/// <item>
/// <description>
/// By default, <see cref="IServiceProvider"/> parameters are bound from the <see cref="AIFunctionArguments.Services"/> property
/// By default, <see cref="IServiceProvider"/> parameters are bound from the <see cref="AIFunctionArguments.Services"/> property
/// and are not included in the JSON schema. If the parameter is optional, such that a default value is provided,
/// <see cref="AIFunctionArguments.Services"/> is allowed to be <see langword="null"/>; otherwise, <see cref="AIFunctionArguments.Services"/>
/// must be non-<see langword="null"/>, or else the invocation will fail with an exception due to the required nature of the parameter.
/// </description>
/// </item>
/// <item>
/// <description>
/// By default, <see cref="AIFunctionArguments"/> parameters are bound directly to <see cref="AIFunctionArguments"/> instance
/// By default, <see cref="AIFunctionArguments"/> parameters are bound directly to <see cref="AIFunctionArguments"/> instance
/// passed into <see cref="AIFunction.InvokeAsync"/> and are not included in the JSON schema. If the <see cref="AIFunctionArguments"/>
/// instance passed to <see cref="AIFunction.InvokeAsync"/> is <see langword="null"/>, the <see cref="AIFunction"/> implementation
/// manufactures an empty instance, such that parameters of type <see cref="AIFunctionArguments"/> can always be satisfied, whether
/// optional or not.
/// </description>
/// </item>
/// </list>
/// All other parameter types are bound from the <see cref="AIFunctionArguments"/> dictionary passed into <see cref="AIFunction.InvokeAsync"/>
Expand Down Expand Up @@ -218,30 +206,24 @@ public static AIFunction Create(Delegate method, string? name = null, string? de
/// <see cref="AIFunctionDeclaration.JsonSchema"/>. There are a few exceptions to this:
/// <list type="bullet">
/// <item>
/// <description>
/// <see cref="CancellationToken"/> parameters are automatically bound to the <see cref="CancellationToken"/> passed into
/// <see cref="CancellationToken"/> parameters are automatically bound to the <see cref="CancellationToken"/> passed into
/// the invocation via <see cref="AIFunction.InvokeAsync"/>'s <see cref="CancellationToken"/> parameter. The parameter is
/// not included in the generated JSON schema. The behavior of <see cref="CancellationToken"/> parameters can't be overridden.
/// </description>
/// </item>
/// <item>
/// <description>
/// By default, <see cref="IServiceProvider"/> parameters are bound from the <see cref="AIFunctionArguments.Services"/> property
/// By default, <see cref="IServiceProvider"/> parameters are bound from the <see cref="AIFunctionArguments.Services"/> property
/// and are not included in the JSON schema. If the parameter is optional, such that a default value is provided,
/// <see cref="AIFunctionArguments.Services"/> is allowed to be <see langword="null"/>; otherwise, <see cref="AIFunctionArguments.Services"/>
/// must be non-<see langword="null"/>, or else the invocation will fail with an exception due to the required nature of the parameter.
/// The handling of <see cref="IServiceProvider"/> parameters can be overridden via <see cref="AIFunctionFactoryOptions.ConfigureParameterBinding"/>.
/// </description>
/// </item>
/// <item>
/// <description>
/// By default, <see cref="AIFunctionArguments"/> parameters are bound directly to <see cref="AIFunctionArguments"/> instance
/// By default, <see cref="AIFunctionArguments"/> parameters are bound directly to <see cref="AIFunctionArguments"/> instance
/// passed into <see cref="AIFunction.InvokeAsync"/> and are not included in the JSON schema. If the <see cref="AIFunctionArguments"/>
/// instance passed to <see cref="AIFunction.InvokeAsync"/> is <see langword="null"/>, the <see cref="AIFunction"/> implementation
/// manufactures an empty instance, such that parameters of type <see cref="AIFunctionArguments"/> can always be satisfied, whether
/// optional or not. The handling of <see cref="AIFunctionArguments"/> parameters can be overridden via
/// <see cref="AIFunctionFactoryOptions.ConfigureParameterBinding"/>.
/// </description>
/// </item>
/// </list>
/// All other parameter types are, by default, bound from the <see cref="AIFunctionArguments"/> dictionary passed into <see cref="AIFunction.InvokeAsync"/>
Expand Down Expand Up @@ -312,28 +294,22 @@ public static AIFunction Create(MethodInfo method, object? target, AIFunctionFac
/// <see cref="AIFunctionDeclaration.JsonSchema"/>. There are a few exceptions to this:
/// <list type="bullet">
/// <item>
/// <description>
/// <see cref="CancellationToken"/> parameters are automatically bound to the <see cref="CancellationToken"/> passed into
/// <see cref="CancellationToken"/> parameters are automatically bound to the <see cref="CancellationToken"/> passed into
/// the invocation via <see cref="AIFunction.InvokeAsync"/>'s <see cref="CancellationToken"/> parameter. The parameter is
/// not included in the generated JSON schema.
/// </description>
/// </item>
/// <item>
/// <description>
/// By default, <see cref="IServiceProvider"/> parameters are bound from the <see cref="AIFunctionArguments.Services"/> property
/// By default, <see cref="IServiceProvider"/> parameters are bound from the <see cref="AIFunctionArguments.Services"/> property
/// and are not included in the JSON schema. If the parameter is optional, such that a default value is provided,
/// <see cref="AIFunctionArguments.Services"/> is allowed to be <see langword="null"/>; otherwise, <see cref="AIFunctionArguments.Services"/>
/// must be non-<see langword="null"/>, or else the invocation will fail with an exception due to the required nature of the parameter.
/// </description>
/// </item>
/// <item>
/// <description>
/// By default, <see cref="AIFunctionArguments"/> parameters are bound directly to <see cref="AIFunctionArguments"/> instance
/// By default, <see cref="AIFunctionArguments"/> parameters are bound directly to <see cref="AIFunctionArguments"/> instance
/// passed into <see cref="AIFunction.InvokeAsync"/> and are not included in the JSON schema. If the <see cref="AIFunctionArguments"/>
/// instance passed to <see cref="AIFunction.InvokeAsync"/> is <see langword="null"/>, the <see cref="AIFunction"/> implementation
/// manufactures an empty instance, such that parameters of type <see cref="AIFunctionArguments"/> can always be satisfied, whether
/// optional or not.
/// </description>
/// </item>
/// </list>
/// All other parameter types are bound from the <see cref="AIFunctionArguments"/> dictionary passed into <see cref="AIFunction.InvokeAsync"/>
Expand Down Expand Up @@ -408,30 +384,24 @@ public static AIFunction Create(MethodInfo method, object? target, string? name
/// <see cref="AIFunctionDeclaration.JsonSchema"/>. There are a few exceptions to this:
/// <list type="bullet">
/// <item>
/// <description>
/// <see cref="CancellationToken"/> parameters are automatically bound to the <see cref="CancellationToken"/> passed into
/// <see cref="CancellationToken"/> parameters are automatically bound to the <see cref="CancellationToken"/> passed into
/// the invocation via <see cref="AIFunction.InvokeAsync"/>'s <see cref="CancellationToken"/> parameter. The parameter is
/// not included in the generated JSON schema. The behavior of <see cref="CancellationToken"/> parameters can't be overridden.
/// </description>
/// </item>
/// <item>
/// <description>
/// By default, <see cref="IServiceProvider"/> parameters are bound from the <see cref="AIFunctionArguments.Services"/> property
/// By default, <see cref="IServiceProvider"/> parameters are bound from the <see cref="AIFunctionArguments.Services"/> property
/// and are not included in the JSON schema. If the parameter is optional, such that a default value is provided,
/// <see cref="AIFunctionArguments.Services"/> is allowed to be <see langword="null"/>; otherwise, <see cref="AIFunctionArguments.Services"/>
/// must be non-<see langword="null"/>, or else the invocation will fail with an exception due to the required nature of the parameter.
/// The handling of <see cref="IServiceProvider"/> parameters can be overridden via <see cref="AIFunctionFactoryOptions.ConfigureParameterBinding"/>.
/// </description>
/// </item>
/// <item>
/// <description>
/// By default, <see cref="AIFunctionArguments"/> parameters are bound directly to <see cref="AIFunctionArguments"/> instance
/// By default, <see cref="AIFunctionArguments"/> parameters are bound directly to <see cref="AIFunctionArguments"/> instance
/// passed into <see cref="AIFunction.InvokeAsync"/> and are not included in the JSON schema. If the <see cref="AIFunctionArguments"/>
/// instance passed to <see cref="AIFunction.InvokeAsync"/> is <see langword="null"/>, the <see cref="AIFunction"/> implementation
/// manufactures an empty instance, such that parameters of type <see cref="AIFunctionArguments"/> can always be satisfied, whether
/// optional or not. The handling of <see cref="AIFunctionArguments"/> parameters can be overridden via
/// <see cref="AIFunctionFactoryOptions.ConfigureParameterBinding"/>.
/// </description>
/// </item>
/// </list>
/// All other parameter types are, by default, bound from the <see cref="AIFunctionArguments"/> dictionary passed into <see cref="AIFunction.InvokeAsync"/>
Expand Down
8 changes: 4 additions & 4 deletions ...aries/Microsoft.Extensions.Resilience/Resilience/ResilienceServiceCollectionExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,11 @@ public static class ResilienceServiceCollectionExtensions
/// <remarks>
/// This method adds additional dimensions on top of the default ones that are built-in to the Polly library. These include:
/// <list type="bullet">
/// <item><description>
/// Exception enrichment based on <see cref="IExceptionSummarizer"/>.</description>
/// <item>
/// Exception enrichment based on <see cref="IExceptionSummarizer"/>.
/// </item>
/// <item><description>
/// Request metadata enrichment based on <see cref="RequestMetadata"/>.</description>
/// <item>
/// Request metadata enrichment based on <see cref="RequestMetadata"/>.
/// </item>
/// </list>
/// </remarks>
Expand Down
32 changes: 16 additions & 16 deletions src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Http/RequestMetadata.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,14 @@ public RequestMetadata(string methodType, string requestRoute, string requestNam
/// <remarks>
/// Request Route is used for multiple use cases:
/// <list type="bullet">
/// <item><description>
/// For outgoing request metrics, it is used as the request name dimension (if RequestName is not provided).</description>
/// <item>
/// For outgoing request metrics, it is used as the request name dimension (if RequestName is not provided).
/// </item>
/// <item><description>
/// <item>
/// For Logs and traces, it is used to identify sensitive parameters from the path and redact them in the exported path, so sensitive data leakage can be avoided.
/// If you are using redaction, the template should be accurate for the request else redaction won't be applied to sensitive parameters.
/// For example, the template would look something like /v1/users/{userId}/chats/{chatId}/messages. For parameters to be redacted, the sensitive parameter names should match exactly as provided
/// in configuration for outgoing tracing and outgoing logging autocollectors.</description>
/// in configuration for outgoing tracing and outgoing logging autocollectors.
/// </item>
/// </list>
/// </remarks>
Expand All @@ -63,17 +63,17 @@ public RequestMetadata(string methodType, string requestRoute, string requestNam
/// <remarks>
/// RequestName is used in the following manner by outgoing HTTP request auto collectors:
/// <list type="bullet">
/// <item><description>
/// For outgoing request metrics: RequestName is used as the request name dimension if present. If not provided, the RequestRoute value is used instead.</description>
/// <item>
/// For outgoing request metrics: RequestName is used as the request name dimension if present. If not provided, the RequestRoute value is used instead.
/// </item>
/// <item><description>
/// For outgoing request traces: RequestName is used as the Display name for the activity. That is, when looking at the E2E trace flow, this name is used in the Tree view of traces.</description>
/// <item>
/// For outgoing request traces: RequestName is used as the Display name for the activity. That is, when looking at the E2E trace flow, this name is used in the Tree view of traces.
/// </item>
/// <item><description>
/// If RequestName isn't provided, the RequestRoute value is used instead.</description>
/// <item>
/// If RequestName isn't provided, the RequestRoute value is used instead.
/// </item>
/// <item><description>
/// For outgoing request logs: When present, RequestName is added as an additional tag to logs.</description>
/// <item>
/// For outgoing request logs: When present, RequestName is added as an additional tag to logs.
/// </item>
/// </list>
/// </remarks>
Expand All @@ -85,11 +85,11 @@ public RequestMetadata(string methodType, string requestRoute, string requestNam
/// <remarks>
/// DependencyName is used in the following manner by outgoing http request auto collectors:
/// <list type="bullet">
/// <item><description>
/// For outgoing request metrics: This is added as dependency name dimension so metrics can be pivoted based on the dependency.</description>
/// <item>
/// For outgoing request metrics: This is added as dependency name dimension so metrics can be pivoted based on the dependency.
/// </item>
/// <item><description>
/// For outgoing request traces and logs: This is added as dependency name dimension for better diagnosability.</description>
/// <item>
/// For outgoing request traces and logs: This is added as dependency name dimension for better diagnosability.
/// </item>
/// </list>
/// </remarks>
Expand Down
4 changes: 1 addition & 3 deletions src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Logging/TagProviderAttribute.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,10 @@ public sealed class TagProviderAttribute : Attribute
/// The method referenced by this constructor should be non-generic, <c>static</c>, and <c>public</c>, and it should have two parameters:
/// <list type="bullet">
/// <item>
/// <description>First parameter of type <see cref="ITagCollector"/>.</description>
/// First parameter of type <see cref="ITagCollector"/>.
/// </item>
/// <item>
/// <description>
/// Second parameter of type <c>T?</c>, where <c>T</c> is the type of logging method parameter that you want to log.
/// </description>
/// </item>
/// </list>
/// </remarks>
Expand Down
10 changes: 5 additions & 5 deletions src/Libraries/Microsoft.Extensions.Telemetry.Abstractions/Metrics/CounterAttribute.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ namespace Microsoft.Extensions.Diagnostics.Metrics;
/// <remarks>
/// This attribute is applied to a method that has the following constraints:
/// <list type="bullet">
/// <item><description>Must be a partial method.</description></item>
/// <item><description>Must return <c>metricName</c> as the type. A class with that name will be generated.</description></item>
/// <item><description>Must not be generic.</description></item>
/// <item><description>Must have <c>System.Diagnostics.Metrics.Meter</c> as first parameter.</description></item>
/// <item><description>Must have all the keys provided in <c>staticTagNames</c> as string type parameters.</description></item>
/// <item>Must be a partial method.</item>
/// <item>Must return <c>metricName</c> as the type. A class with that name will be generated.</item>
/// <item>Must not be generic.</item>
/// <item>Must have <c>System.Diagnostics.Metrics.Meter</c> as first parameter.</item>
/// <item>Must have all the keys provided in <c>staticTagNames</c> as string type parameters.</item>
/// </list>
/// </remarks>
/// <example>
Expand Down
Loading
Loading