Skip to content

Commit 7fef00a

Browse files
authored
small doc fixes (#6887)
1 parent 254951e commit 7fef00a

File tree

9 files changed

+13
-13
lines changed

9 files changed

+13
-13
lines changed

src/Libraries/Microsoft.Extensions.AI.Abstractions/Contents/McpServerToolCallContent.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ public sealed class McpServerToolCallContent : AIContent
2424
/// <param name="callId">The tool call ID.</param>
2525
/// <param name="toolName">The tool name.</param>
2626
/// <param name="serverName">The MCP server name.</param>
27-
/// <exception cref="ArgumentNullException"><paramref name="callId"/>, <paramref name="toolName"/>, or <paramref name="serverName"/> are <see langword="null"/>.</exception>
27+
/// <exception cref="ArgumentNullException"><paramref name="callId"/>, <paramref name="toolName"/>, or <paramref name="serverName"/> is <see langword="null"/>.</exception>
2828
/// <exception cref="ArgumentException"><paramref name="callId"/>, <paramref name="toolName"/>, or <paramref name="serverName"/> are empty or composed entirely of whitespace.</exception>
2929
public McpServerToolCallContent(string callId, string toolName, string serverName)
3030
{

src/Libraries/Microsoft.Extensions.AI.Abstractions/Tools/HostedMcpServerTool.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ public class HostedMcpServerTool : AITool
1919
/// </summary>
2020
/// <param name="serverName">The name of the remote MCP server.</param>
2121
/// <param name="url">The URL of the remote MCP server.</param>
22-
/// <exception cref="ArgumentNullException"><paramref name="serverName"/> or <paramref name="url"/> are <see langword="null"/>.</exception>
22+
/// <exception cref="ArgumentNullException"><paramref name="serverName"/> or <paramref name="url"/> is <see langword="null"/>.</exception>
2323
/// <exception cref="ArgumentException"><paramref name="serverName"/> is empty or composed entirely of whitespace.</exception>
2424
public HostedMcpServerTool(string serverName, [StringSyntax(StringSyntaxAttribute.Uri)] string url)
2525
: this(serverName, new Uri(Throw.IfNull(url)))
@@ -31,7 +31,7 @@ public HostedMcpServerTool(string serverName, [StringSyntax(StringSyntaxAttribut
3131
/// </summary>
3232
/// <param name="serverName">The name of the remote MCP server.</param>
3333
/// <param name="url">The URL of the remote MCP server.</param>
34-
/// <exception cref="ArgumentNullException"><paramref name="serverName"/> or <paramref name="url"/> are <see langword="null"/>.</exception>
34+
/// <exception cref="ArgumentNullException"><paramref name="serverName"/> or <paramref name="url"/> is <see langword="null"/>.</exception>
3535
/// <exception cref="ArgumentException"><paramref name="serverName"/> is empty or composed entirely of whitespace.</exception>
3636
public HostedMcpServerTool(string serverName, Uri url)
3737
{

src/Libraries/Microsoft.Extensions.AI.Evaluation.Reporting/CSharp/IEvaluationReportWriter.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ public interface IEvaluationReportWriter
1717
/// Writes a report containing all the <see cref="EvaluationMetric"/>s present in the supplied
1818
/// <paramref name="scenarioRunResults"/>s.
1919
/// </summary>
20-
/// <param name="scenarioRunResults">An enumeration of <see cref="ScenarioRunResult"/>s.</param>
20+
/// <param name="scenarioRunResults">A collection of run results from which to generate the report.</param>
2121
/// <param name="cancellationToken">A <see cref="CancellationToken"/> that can cancel the operation.</param>
2222
/// <returns>A <see cref="ValueTask"/> that represents the asynchronous operation.</returns>
2323
ValueTask WriteReportAsync(

src/Libraries/Microsoft.Extensions.AmbientMetadata.Application/ApplicationMetadataConfigurationBuilderExtensions.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ public static class ApplicationMetadataConfigurationBuilderExtensions
2020
/// </summary>
2121
/// <param name="builder">The configuration builder.</param>
2222
/// <param name="hostEnvironment">An instance of <see cref="IHostEnvironment" />.</param>
23-
/// <param name="sectionName">Section name to save configuration into. Default set to "ambientmetadata:application".</param>
24-
/// <returns>The value of <paramref name="builder"/>>.</returns>
23+
/// <param name="sectionName">The section name to save configuration into. The default is "ambientmetadata:application".</param>
24+
/// <returns>The value of <paramref name="builder"/>.</returns>
2525
/// <exception cref="ArgumentNullException"><paramref name="builder"/> or <paramref name="hostEnvironment"/> is <see langword="null"/>.</exception>
2626
/// <exception cref="ArgumentException"><paramref name="sectionName"/> is either <see langword="null"/>, empty, or whitespace.</exception>
2727
public static IConfigurationBuilder AddApplicationMetadata(this IConfigurationBuilder builder, IHostEnvironment hostEnvironment, string sectionName = DefaultSectionName)

src/Libraries/Microsoft.Extensions.AmbientMetadata.Application/ApplicationMetadataServiceCollectionExtensions.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ public static IServiceCollection AddApplicationMetadata(this IServiceCollection
3535
/// </summary>
3636
/// <param name="services">The dependency injection container to add the instance to.</param>
3737
/// <param name="configure">The delegate to configure <see cref="ApplicationMetadata"/> with.</param>
38-
/// <returns>The value of <paramref name="services"/>>.</returns>
38+
/// <returns>The value of <paramref name="services"/>.</returns>
3939
/// <exception cref="ArgumentNullException"><paramref name="services"/> or <paramref name="configure"/> is <see langword="null"/>.</exception>
4040
public static IServiceCollection AddApplicationMetadata(this IServiceCollection services, Action<ApplicationMetadata> configure)
4141
{

src/Libraries/Microsoft.Extensions.AsyncState/IAsyncContext.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ namespace Microsoft.Extensions.AsyncState;
88

99
/// <summary>
1010
/// Provides access to the current async context.
11-
/// Some implementations of this interface may not be thread safe.
11+
/// Some implementations of this interface might not be thread safe.
1212
/// </summary>
1313
/// <typeparam name="T">The type of the asynchronous state.</typeparam>
1414
public interface IAsyncContext<T>

src/Libraries/Microsoft.Extensions.AsyncState/IAsyncLocalContext.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ namespace Microsoft.Extensions.AsyncState;
77

88
/// <summary>
99
/// Provides access to the current async context stored outside of the HTTP pipeline.
10-
/// Some implementations of this interface may not be thread safe.
10+
/// Some implementations of this interface might not be thread safe.
1111
/// </summary>
1212
/// <typeparam name="T">The type of the asynchronous state.</typeparam>
1313
/// <remarks>This type is intended for internal use. Use <see cref="IAsyncContext{T}"/> instead.</remarks>

src/Libraries/Microsoft.Extensions.AsyncState/IAsyncState.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ namespace Microsoft.Extensions.AsyncState;
99

1010
/// <summary>
1111
/// Encapsulates all information within the asynchronous flow in an <see cref="AsyncLocal{T}"/> variable.
12-
/// Some implementations of this interface may not be thread safe.
12+
/// Some implementations of this interface might not be thread safe.
1313
/// </summary>
1414
public interface IAsyncState
1515
{

src/Libraries/Microsoft.Extensions.Compliance.Testing/FakeRedactionServiceCollectionExtensions.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public static class FakeRedactionServiceCollectionExtensions
1818
/// <summary>
1919
/// Registers the fake redactor provider that always returns fake redactor instances.
2020
/// </summary>
21-
/// <param name="services">Container used to register fake redaction classes.</param>
21+
/// <param name="services">The container used to register fake redaction classes.</param>
2222
/// <returns>The value of <paramref name="services" />.</returns>
2323
/// <exception cref="ArgumentNullException"><paramref name="services"/> is <see langword="null"/>.</exception>
2424
public static IServiceCollection AddFakeRedaction(this IServiceCollection services)
@@ -42,10 +42,10 @@ public static IServiceCollection AddFakeRedaction(this IServiceCollection servic
4242
/// <summary>
4343
/// Registers the fake redactor provider that always returns fake redactor instances.
4444
/// </summary>
45-
/// <param name="services">Container used to register fake redaction classes.</param>
45+
/// <param name="services">The container used to register fake redaction classes.</param>
4646
/// <param name="configure">Configures fake redactor.</param>
4747
/// <returns>The value of <paramref name="services" />.</returns>
48-
/// <exception cref="ArgumentNullException"><paramref name="services"/> or <paramref name="configure"/>> are <see langword="null"/>.</exception>
48+
/// <exception cref="ArgumentNullException"><paramref name="services"/> or <paramref name="configure"/> is <see langword="null"/>.</exception>
4949
public static IServiceCollection AddFakeRedaction(this IServiceCollection services, Action<FakeRedactorOptions> configure)
5050
{
5151
_ = Throw.IfNull(services);

0 commit comments

Comments
 (0)