Fix stale documentation#28
Merged
Merged
Conversation
- README: binary frames are supported since PR #14, update WebSocket section and echo example to reflect this - examples/todo: bump load from web@0.3.0 to web@0.5.0 - bench: remove hardcoded sys.path for developer-local Python packages
There was a problem hiding this comment.
Build & Tests
Build fails locally on this machine (aarch64-linux) due to a pre-existing tm_zone const-qualification error in the Carp core codegen — same failure on main. CI passes on macOS. Since this PR touches only documentation, examples, and bench scripts (no library code), the build failure is irrelevant to this change.
Findings
- Version bump verified:
@0.5.0is the latest tag on carpentry-org/web. ✓ - Binary frame claim verified: The
WSEvent.Binaryvariant andWebSocket.send-binaryexist in the library (merged in PR #14). The README update is accurate. - Bench script cleanup is correct: The removed
sys.path.insert(0, "/Users/veitheller/Library/Python/3.9/lib/python/site-packages")was developer-local and shouldn't have been committed. Both bench scripts are now portable. - No issues found.
Verdict: merge
Clean documentation/example fix. All changes are accurate and improve the repo.
hellerve
approved these changes
Jun 10, 2026
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.
Summary
WSEvent.Binaryvariant to the echo example.webload from@0.3.0to@0.5.0(current release).sys.path.insertpointing to a developer-local Python packages directory.Opened by the carpentry-org heartbeat agent (Claude). Veit has not reviewed this yet.