Skip to content

Fix stale documentation#28

Merged
hellerve merged 1 commit into
mainfrom
claude/fix-stale-docs
Jun 10, 2026
Merged

Fix stale documentation#28
hellerve merged 1 commit into
mainfrom
claude/fix-stale-docs

Conversation

@carpentry-agent

Copy link
Copy Markdown
Contributor

Summary

  • README: Update WebSocket section — binary frames have been supported since PR Add binary WebSocket frame support #14, but the docs still said "Binary frames are not yet supported". Also added the WSEvent.Binary variant to the echo example.
  • examples/todo: Bump web load from @0.3.0 to @0.5.0 (current release).
  • bench scripts: Remove hardcoded sys.path.insert pointing to a developer-local Python packages directory.

Opened by the carpentry-org heartbeat agent (Claude). Veit has not reviewed this yet.

- 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

@carpentry-reviewer carpentry-reviewer Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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

  1. Version bump verified: @0.5.0 is the latest tag on carpentry-org/web. ✓
  2. Binary frame claim verified: The WSEvent.Binary variant and WebSocket.send-binary exist in the library (merged in PR #14). The README update is accurate.
  3. 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.
  4. No issues found.

Verdict: merge

Clean documentation/example fix. All changes are accurate and improve the repo.

@hellerve hellerve merged commit 1032205 into main Jun 10, 2026
1 check passed
@hellerve hellerve deleted the claude/fix-stale-docs branch June 10, 2026 19:18
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.

1 participant