Skip to content

fix typos in XML doc comments, ADR docs, and test comments#7085

Open
rinceyuan wants to merge 1 commit into
microsoft:mainfrom
rinceyuan:fix/docs-typos-and-adr-frontmatter
Open

fix typos in XML doc comments, ADR docs, and test comments#7085
rinceyuan wants to merge 1 commit into
microsoft:mainfrom
rinceyuan:fix/docs-typos-and-adr-frontmatter

Conversation

@rinceyuan

Copy link
Copy Markdown

Motivation & Context

Fix minor typos and leftover template text in documentation and XML doc comments.

Description & Review Guide

  • 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 thesimilar to the in ADR 0009 (line 1092)
  • Fix reponseresponse in ADR 0001 (line 142)
  • Fix retreiveretrieve in ChatClientAgentTests.cs (line 467)
  • Remove leftover template placeholder text from ADR 0001 and 0006 frontmatter date fields

Related Issue

N/A (documentation hygiene)

Contribution Checklist

  • The code builds clean without any errors or warnings
  • All unit tests pass, and I have added new tests where possible
  • The PR follows the Contribution Guidelines
  • This is not a breaking change.

- 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
Copilot AI review requested due to automatic review settings July 13, 2026 06:37
@giles17 giles17 added documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs .NET Usage: [Issues, PRs], Target: .Net labels Jul 13, 2026
@github-actions github-actions Bot changed the title docs/.NET: fix typos in XML doc comments, ADR docs, and test comments .NET: docs/.NET: fix typos in XML doc comments, ADR docs, and test comments Jul 13, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 date fields 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.

@rinceyuan

Copy link
Copy Markdown
Author

@microsoft-github-policy-service agree company=Microsoft

@rinceyuan rinceyuan changed the title .NET: docs/.NET: fix typos in XML doc comments, ADR docs, and test comments docs: fix typos in XML doc comments, ADR docs, and test comments Jul 13, 2026
@rinceyuan rinceyuan changed the title docs: fix typos in XML doc comments, ADR docs, and test comments fix typos in XML doc comments, ADR docs, and test comments Jul 13, 2026
@rinceyuan

Copy link
Copy Markdown
Author

@moonbox3 @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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs .NET Usage: [Issues, PRs], Target: .Net

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants