Skip to content

Fix SDK documentation typos#1235

Merged
stephentoub merged 2 commits intomainfrom
stephentoub/docs-typo-review
May 8, 2026
Merged

Fix SDK documentation typos#1235
stephentoub merged 2 commits intomainfrom
stephentoub/docs-typo-review

Conversation

@stephentoub
Copy link
Copy Markdown
Collaborator

This cleanup fixes small grammar and wording issues across the SDK documentation and public comments so examples and API docs read consistently for users.

The changes tighten wording in README guidance, OAuth and MCP docs, Node and .NET README snippets, C# and Go comments, and Python JSON-RPC docstrings without changing runtime behavior.

Validation:

  • go test ./internal/jsonrpc2 ./internal/embeddedcli
  • python -m pytest test_jsonrpc.py
  • dotnet format src\GitHub.Copilot.SDK.csproj --verify-no-changes --include src\JsonRpc.cs
  • npm exec --yes --package prettier@3.8.1 -- prettier --check src\sessionFsProvider.ts

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings May 8, 2026 15:33
@stephentoub stephentoub requested a review from a team as a code owner May 8, 2026 15:33
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Documentation and comment cleanup across the multi-language Copilot SDK repo to improve grammar/wording consistency in user-facing READMEs, docs, and inline API comments.

Changes:

  • Refines wording/grammar in top-level and language-specific READMEs and troubleshooting/setup docs.
  • Polishes Python JSON-RPC docstrings and a related test helper docstring for consistency and punctuation.
  • Minor text adjustments in Go/.NET/Node comments (including one verbose Go install log string).
Show a summary per file
File Description
README.md Rewords FAQ explanation of default tool enablement for clarity.
python/test_jsonrpc.py Docstring punctuation/wording tweak in test helper.
python/copilot/_jsonrpc.py Docstring wording/punctuation improvements in JSON-RPC client.
nodejs/src/sessionFsProvider.ts Fixes terminology in interface comment (“Implementers”).
nodejs/README.md Clarifies example comment text in Quick Start snippet.
go/internal/jsonrpc2/frame.go Adjusts comment wording for framing header description.
go/internal/embeddedcli/embeddedcli.go Tweaks verbose install log message text.
dotnet/src/JsonRpc.cs Corrects spelling in an explanatory framing comment.
dotnet/README.md Clarifies example comment text in Quick Start snippet.
docs/troubleshooting/mcp-debugging.md Small wording tweak in a shell snippet comment.
docs/setup/github-oauth.md Fixes article usage (“an SDK client”).

Copilot's findings

  • Files reviewed: 11/11 changed files
  • Comments generated: 1

Comment thread go/internal/embeddedcli/embeddedcli.go
@github-actions

This comment has been minimized.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 8, 2026

Cross-SDK Consistency Review ✅

This PR makes purely textual corrections (grammar, article usage, wording) across documentation files and inline comments/docstrings. No public API surface, method signatures, parameter types, or runtime behavior is changed in any SDK.

No cross-SDK consistency issues found. The changes touch Node.js, Python, Go, and .NET in parallel (plus shared docs), so parity is maintained throughout.

Generated by SDK Consistency Review Agent for issue #1235 · ● 103K ·

@stephentoub stephentoub merged commit ce56eb8 into main May 8, 2026
37 checks passed
@stephentoub stephentoub deleted the stephentoub/docs-typo-review branch May 8, 2026 15:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants