.NET: dotnet samples suggestions #1581
Open
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
github-actions
bot
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR updates .NET sample code to improve consistency and simplify named arguments. The key changes remove redundant named arguments for cancellationToken parameters, replace generic Exception types with more appropriate exception types in some cases, and adjust the CA2201 diagnostic severity to allow generic exceptions in samples.
Key Changes:
- Removed unnecessary
cancellationToken:named arguments throughout workflow samples, simplifying method calls - Changed exception types from
InvalidOperationExceptiontoExceptionorArgumentExceptionwhere appropriate - Updated
.editorconfigto change CA2201 diagnostic from warning to suggestion, allowing generic exceptions in sample code
Reviewed Changes
Copilot reviewed 19 out of 19 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| dotnet/.editorconfig | Changed CA2201 severity from warning to suggestion to allow generic exceptions |
| dotnet/samples/GettingStarted/Workflows/_Foundational/04_AgentWorkflowPatterns/Program.cs | Changed exception type to Exception and removed trailing period from comment |
| dotnet/samples/GettingStarted/Workflows/_Foundational/03_AgentsInWorkflows/Program.cs | Changed exception type from InvalidOperationException to Exception |
| dotnet/samples/GettingStarted/Workflows/Loop/Program.cs | Removed named cancellationToken: arguments from SendMessageAsync calls |
| dotnet/samples/GettingStarted/Workflows/HumanInTheLoop/HumanInTheLoopBasic/WorkflowHelper.cs | Removed named cancellationToken: arguments from SendMessageAsync calls |
| dotnet/samples/GettingStarted/Workflows/HumanInTheLoop/HumanInTheLoopBasic/Program.cs | Refactored HandleExternalRequest to use nullable switch pattern and ArgumentException |
| dotnet/samples/GettingStarted/Workflows/ConditionalEdges/03_MultiSelection/Program.cs | Changed exception types and removed named cancellationToken arguments |
| dotnet/samples/GettingStarted/Workflows/ConditionalEdges/02_SwitchCase/Program.cs | Changed exception types from InvalidOperationException to Exception/ArgumentException |
| dotnet/samples/GettingStarted/Workflows/ConditionalEdges/01_EdgeCondition/Program.cs | Changed exception types from InvalidOperationException to Exception/ArgumentException |
| dotnet/samples/GettingStarted/Workflows/Concurrent/MapReduce/Program.cs | Removed named cancellationToken: arguments from SendMessageAsync calls |
| dotnet/samples/GettingStarted/Workflows/Concurrent/Concurrent/Program.cs | Changed exception type and removed named cancellationToken arguments |
| dotnet/samples/GettingStarted/Workflows/Checkpoint/CheckpointWithHumanInTheLoop/WorkflowHelper.cs | Removed named cancellationToken: arguments from multiple methods |
| dotnet/samples/GettingStarted/Workflows/Checkpoint/CheckpointAndResume/WorkflowHelper.cs | Removed named cancellationToken: arguments from multiple methods |
| dotnet/samples/GettingStarted/Workflows/Checkpoint/CheckpointAndRehydrate/WorkflowHelper.cs | Removed named cancellationToken: arguments from multiple methods |
| dotnet/samples/GettingStarted/Workflows/Agents/WorkflowAsAnAgent/WorkflowHelper.cs | Removed named cancellationToken: arguments from SendMessageAsync calls |
| dotnet/samples/GettingStarted/Workflows/Agents/WorkflowAsAnAgent/Program.cs | Changed exception type from InvalidOperationException to Exception |
| dotnet/samples/GettingStarted/Workflows/Agents/FoundryAgent/Program.cs | Changed exception type and updated comment from OpenAI to Foundry |
| dotnet/samples/GettingStarted/Workflows/Agents/CustomAgentExecutors/Program.cs | Changed exception type and removed named cancellationToken argument |
| dotnet/samples/AgentWebChat/AgentWebChat.Web/OpenAIResponsesAgentClient.cs | Removed named cancellationToken: argument from GetStreamingResponseAsync call |
dotnet/samples/GettingStarted/Workflows/HumanInTheLoop/HumanInTheLoopBasic/Program.cs
Show resolved
Hide resolved
TaoChenOSU
reviewed
Oct 21, 2025
| { | ||
| // Set up the Azure OpenAI client | ||
| var endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT") ?? throw new InvalidOperationException("AZURE_OPENAI_ENDPOINT is not set."); | ||
| var endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_ENDPOINT") ?? throw new Exception("AZURE_OPENAI_ENDPOINT is not set."); |
There was a problem hiding this comment.
What is the reason to use a less concrete exception?
There was a problem hiding this comment.
The change is about not throwing InvalidOperationException since those are meant for instance method calls and convey that the object's state is invalid.
https://learn.microsoft.com/dotnet/api/system.invalidoperationexception
The exception that is thrown when a method call is invalid for the object's current state.
There was a problem hiding this comment.
Then perhaps another exception type? For example: "ArgumentException".
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 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.
@TaoChenOSU @westey-m