Repository navigation
docs: clarify LoggingTransport log contents - #1452
Open
kimjooyoon wants to merge 1 commit into
Open
kimjooyoon wants to merge 1 commit into
kimjooyoon wants to merge 1 commit into
Conversation
Explain that LoggingTransport re-encodes JSON-RPC messages and does not preserve the original byte stream. Point stdio byte-level diagnostics to the underlying IOTransport readers and writers, and regenerate the corresponding guide.
kimjooyoon
marked this pull request as ready for review
October 25, 2026 18:33
This branch has not been deployed
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.
LoggingTransport logs decoded JSON-RPC messages after re-encoding them, so its output is not a byte-for-byte recording of stdio traffic. Clarify that distinction in the troubleshooting guide and point readers who need exact bytes to the Reader and Writer of IOTransport.
Regenerated docs/troubleshooting.md from its source with the repository's weave generator. As a control, generating the unchanged source reproduced the existing document byte for byte. The final patch changes the same paragraph in both files and passes git apply --check --whitespace=error-all. This is a documentation-only change; no SDK implementation or examples changed.