From badaedbde94d61ad8e0ba6ea0763d8aa92ba4af0 Mon Sep 17 00:00:00 2001 From: j-zhangyiyuan Date: Fri, 10 Jul 2026 00:13:38 +0800 Subject: [PATCH] docs/.NET: fix typos in XML doc comments, ADR docs, and test comments - Fix double period in AnthropicClientExtensions.cs XML param docs (lines 23, 77) - Fix double period in IScopedContentProcessor.cs XML param doc (line 20) - Fix 'similar the the' -> 'similar to the' in ADR 0009 (line 1092) - Fix 'reponse' -> 'response' in ADR 0001 (line 142) - Fix 'retreive' -> 'retrieve' in ChatClientAgentTests.cs (line 467) - Remove leftover template placeholder from ADR 0001 and 0006 frontmatter --- docs/decisions/0001-agent-run-response.md | 4 ++-- docs/decisions/0006-userapproval.md | 2 +- docs/decisions/0009-support-long-running-operations.md | 2 +- .../AnthropicClientExtensions.cs | 4 ++-- .../Microsoft.Agents.AI.Purview/IScopedContentProcessor.cs | 2 +- .../ChatClient/ChatClientAgentTests.cs | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/decisions/0001-agent-run-response.md b/docs/decisions/0001-agent-run-response.md index 6ffebe7e4f3..68626cb1818 100644 --- a/docs/decisions/0001-agent-run-response.md +++ b/docs/decisions/0001-agent-run-response.md @@ -2,7 +2,7 @@ # These are optional elements. Feel free to remove any of them. status: accepted contact: westey-m -date: 2025-07-10 {YYYY-MM-DD when the decision was last updated} +date: 2025-07-10 deciders: sergeymenshykh, markwallace, rbarreto, dmytrostruk, westey-m, eavanvalkenburg, stephentoub consulted: informed: @@ -139,7 +139,7 @@ Therefore something like `AgentResponse.Text` which also aggregates all `TextCon #### Option 1.2 Presence of Secondary Content is determined by a runtime parameter -We can allow callers to choose whether to include secondary content in the list of reponse messages. +We can allow callers to choose whether to include secondary content in the list of response messages. Open Question: Do we allow secondary content to use `TextContent` types? ```csharp diff --git a/docs/decisions/0006-userapproval.md b/docs/decisions/0006-userapproval.md index 7823ab4de44..df235861f55 100644 --- a/docs/decisions/0006-userapproval.md +++ b/docs/decisions/0006-userapproval.md @@ -2,7 +2,7 @@ # These are optional elements. Feel free to remove any of them. status: accepted contact: westey-m -date: 2025-09-12 {YYYY-MM-DD when the decision was last updated} +date: 2025-09-12 deciders: sergeymenshykh, markwallace-microsoft, rogerbarreto, dmytrostruk, westey-m, eavanvalkenburg, stephentoub, peterychang consulted: informed: diff --git a/docs/decisions/0009-support-long-running-operations.md b/docs/decisions/0009-support-long-running-operations.md index a62a0385531..5cdf15efedc 100644 --- a/docs/decisions/0009-support-long-running-operations.md +++ b/docs/decisions/0009-support-long-running-operations.md @@ -1089,7 +1089,7 @@ public class ChatOptions ##### 6.1.5 Continuation Token of a Custom Type -The option is similar the the "6.1.3 Continuation Token of System.ClientModel.ContinuationToken Type" option but suggests using a +The option is similar to the "6.1.3 Continuation Token of System.ClientModel.ContinuationToken Type" option but suggests using a custom type for the continuation token instead of the `System.ClientModel.ContinuationToken` type. **Pros** diff --git a/dotnet/src/Microsoft.Agents.AI.Anthropic/AnthropicClientExtensions.cs b/dotnet/src/Microsoft.Agents.AI.Anthropic/AnthropicClientExtensions.cs index c0bbd4715d9..be50316b84a 100644 --- a/dotnet/src/Microsoft.Agents.AI.Anthropic/AnthropicClientExtensions.cs +++ b/dotnet/src/Microsoft.Agents.AI.Anthropic/AnthropicClientExtensions.cs @@ -20,7 +20,7 @@ public static class AnthropicClientExtensions /// /// Creates a new AI agent using the specified model and options. /// - /// An Anthropic to use with the agent.. + /// An Anthropic to use with the agent. /// The model to use for chat completions. /// The instructions for the AI agent. /// The name of the AI agent. @@ -74,7 +74,7 @@ public static ChatClientAgent AsAIAgent( /// /// Creates an AI agent from an using the Anthropic Chat Completion API. /// - /// An Anthropic to use with the agent.. + /// An Anthropic to use with the agent. /// Full set of options to configure the agent. /// Provides a way to customize the creation of the underlying used by the agent. /// Optional logger factory for enabling logging within the agent. diff --git a/dotnet/src/Microsoft.Agents.AI.Purview/IScopedContentProcessor.cs b/dotnet/src/Microsoft.Agents.AI.Purview/IScopedContentProcessor.cs index cf60e7ec363..a6951555f6f 100644 --- a/dotnet/src/Microsoft.Agents.AI.Purview/IScopedContentProcessor.cs +++ b/dotnet/src/Microsoft.Agents.AI.Purview/IScopedContentProcessor.cs @@ -17,7 +17,7 @@ internal interface IScopedContentProcessor /// Process a list of messages. /// The list of messages should be a prompt or response. /// - /// A list of objects sent to the agent or received from the agent.. + /// A list of objects sent to the agent or received from the agent. /// The session where the messages were sent. /// An activity to indicate prompt or response. /// Purview settings containing tenant id, app name, etc. diff --git a/dotnet/tests/Microsoft.Agents.AI.UnitTests/ChatClient/ChatClientAgentTests.cs b/dotnet/tests/Microsoft.Agents.AI.UnitTests/ChatClient/ChatClientAgentTests.cs index 6edecb870ac..8082b1a8c92 100644 --- a/dotnet/tests/Microsoft.Agents.AI.UnitTests/ChatClient/ChatClientAgentTests.cs +++ b/dotnet/tests/Microsoft.Agents.AI.UnitTests/ChatClient/ChatClientAgentTests.cs @@ -464,7 +464,7 @@ public async Task RunAsyncSetsAuthorNameOnAllResponseMessagesAsync(string? autho } /// - /// Verify that RunAsync works with existing session and can retreive messages if the session has a ChatHistoryProvider. + /// Verify that RunAsync works with existing session and can retrieve messages if the session has a ChatHistoryProvider. /// [Fact] public async Task RunAsyncRetrievesMessagesFromSessionWhenSessionHasChatHistoryProviderAsync()