fix typos in XML doc comments, ADR docs, and test comments - #7085
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
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. |
|
@microsoft-github-policy-service agree company=Microsoft |
|
Evan Mattson (@moonbox3) Giles Odigwe (@giles17) This is a small documentation-hygiene PR (typo/punctuation fixes only, no functional changes). Would appreciate a review when you get a chance. Thanks! |
|
Hi Evan Mattson (@moonbox3), it looks like auto-merge was reset when the title was updated. All checks are passing and reviews are approved — could you re-enable auto-merge or merge when convenient? Thanks! |
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