Agents SDK API reference documentation #302
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
github-actions
bot
added
ML: Core
There was a problem hiding this comment.
Pull Request Overview
This PR adds the System namespace to cref targets in XML documentation comments so that exception types are rendered as links in the published API reference documentation.
- Updated cref attributes for exception documentation to fully qualify exception types
- Adjusted code formatting in a couple of methods for consistency
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| Verify.cs | Updated cref attributes for ArgumentNullException |
| Record.cs | Updated cref attribute for InvalidCastException and adjusted formatting of closing braces and semicolons |
| ActionPlanner.cs | Updated cref attribute for Exception |
| ChatRole.cs | Updated cref attribute for ArgumentNullException |
| AzureOpenAIModelOptions.cs | Updated cref attribute for ArgumentException |
| IActionCollection.cs | Updated cref attributes for ArgumentException |
| ActionEntry.cs | Updated cref attribute for Exception |
| AI.cs | Updated cref attributes for InvalidOperationException |
src/libraries/Extensions/Microsoft.Agents.Extensions.Teams.AI/State/Record.cs
Show resolved
Hide resolved
src/libraries/Extensions/Microsoft.Agents.Extensions.Teams.AI/State/Record.cs
Show resolved
Hide resolved
phecke
added
documentation
phecke
changed the title
MattB-msft
approved these changes
Jun 3, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
///<exception cref="">targets so they are rendered as links in the published API reference documentation. This fixes doc build warnings.