fix typos in XML doc comments, ADR docs, and test comments#7085
Open
rinceyuan wants to merge 1 commit into
Open
fix typos in XML doc comments, ADR docs, and test comments#7085rinceyuan wants to merge 1 commit into
rinceyuan wants to merge 1 commit into
Conversation
- 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
Contributor
There was a problem hiding this comment.
Pull request overview
This PR performs documentation hygiene across .NET code comments and ADR markdown by correcting typos/punctuation and removing leftover template placeholder text in ADR frontmatter dates.
Changes:
- Fix spelling/punctuation issues in XML doc comments and test comments (e.g., double periods and “retreive” → “retrieve”).
- Correct typos in ADR content (“reponse” → “response”, “similar the the” → “similar to the”).
- Remove template placeholder text from ADR frontmatter
datefields while keeping the intended dates.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| dotnet/tests/Microsoft.Agents.AI.UnitTests/ChatClient/ChatClientAgentTests.cs | Fixes a typo in a test XML summary comment (“retrieve”). |
| dotnet/src/Microsoft.Agents.AI.Purview/IScopedContentProcessor.cs | Removes an extra period in an XML <param> doc comment. |
| dotnet/src/Microsoft.Agents.AI.Anthropic/AnthropicClientExtensions.cs | Removes extra periods in XML <param> doc comments for client. |
| docs/decisions/0009-support-long-running-operations.md | Fixes a grammatical typo in ADR prose (“similar to the”). |
| docs/decisions/0006-userapproval.md | Removes template placeholder text from ADR frontmatter date. |
| docs/decisions/0001-agent-run-response.md | Removes template placeholder text from frontmatter date and fixes “response” typo in ADR prose. |
Author
|
@microsoft-github-policy-service agree company=Microsoft |
Author
moonbox3
approved these changes
Jul 13, 2026
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
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.
Motivation & Context
Fix minor typos and leftover template text in documentation and XML doc comments.
Description & Review Guide
AnthropicClientExtensions.csXML param docs (lines 23, 77)IScopedContentProcessor.csXML param doc (line 20)similar the the→similar to thein ADR 0009 (line 1092)reponse→responsein ADR 0001 (line 142)retreive→retrieveinChatClientAgentTests.cs(line 467)Related Issue
N/A (documentation hygiene)
Contribution Checklist