Fix SDK documentation typos#1235
Merged
stephentoub merged 2 commits intomainfrom May 8, 2026
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
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
This comment has been minimized.
This comment has been minimized.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
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.
|
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.
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/embeddedclipython -m pytest test_jsonrpc.pydotnet format src\GitHub.Copilot.SDK.csproj --verify-no-changes --include src\JsonRpc.csnpm exec --yes --package prettier@3.8.1 -- prettier --check src\sessionFsProvider.ts